Class: Aws::CloudWatch::Types::AnomalyDetector

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatch/types.rb

Overview

An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. You can use the model to display a band of expected, normal values when the metric is graphed.

If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#anomaly_detector_id ⇒ String

The unique identifier of the anomaly detector.

The identifier does not restrict access to a specific anomaly detector in an IAM policy. Permissions for anomaly detector operations apply to all anomaly detectors in the account.

Returns:

  • (String) 


230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 230

class AnomalyDetector < Struct.new(
  :anomaly_detector_id,
  :namespace,
  :metric_name,
  :dimensions,
  :stat,
  :configuration,
  :state_value,
  :metric_characteristics,
  :single_metric_anomaly_detector,
  :metric_math_anomaly_detector)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::AnomalyDetectorConfiguration

The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.

Returns:



230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 230

class AnomalyDetector < Struct.new(
  :anomaly_detector_id,
  :namespace,
  :metric_name,
  :dimensions,
  :stat,
  :configuration,
  :state_value,
  :metric_characteristics,
  :single_metric_anomaly_detector,
  :metric_math_anomaly_detector)
  SENSITIVE = []
  include Aws::Structure
end

#dimensions ⇒ Array<Types::Dimension>

The metric dimensions associated with the anomaly detection model.

Returns:



230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 230

class AnomalyDetector < Struct.new(
  :anomaly_detector_id,
  :namespace,
  :metric_name,
  :dimensions,
  :stat,
  :configuration,
  :state_value,
  :metric_characteristics,
  :single_metric_anomaly_detector,
  :metric_math_anomaly_detector)
  SENSITIVE = []
  include Aws::Structure
end

#metric_characteristics ⇒ Types::MetricCharacteristics

This object includes parameters that you can use to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.

Returns:



230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 230

class AnomalyDetector < Struct.new(
  :anomaly_detector_id,
  :namespace,
  :metric_name,
  :dimensions,
  :stat,
  :configuration,
  :state_value,
  :metric_characteristics,
  :single_metric_anomaly_detector,
  :metric_math_anomaly_detector)
  SENSITIVE = []
  include Aws::Structure
end

#metric_math_anomaly_detector ⇒ Types::MetricMathAnomalyDetector

The CloudWatch metric math expression for this anomaly detector.

Returns:



230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 230

class AnomalyDetector < Struct.new(
  :anomaly_detector_id,
  :namespace,
  :metric_name,
  :dimensions,
  :stat,
  :configuration,
  :state_value,
  :metric_characteristics,
  :single_metric_anomaly_detector,
  :metric_math_anomaly_detector)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

The name of the metric associated with the anomaly detection model.

Returns:

  • (String) 


230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 230

class AnomalyDetector < Struct.new(
  :anomaly_detector_id,
  :namespace,
  :metric_name,
  :dimensions,
  :stat,
  :configuration,
  :state_value,
  :metric_characteristics,
  :single_metric_anomaly_detector,
  :metric_math_anomaly_detector)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace of the metric associated with the anomaly detection model.

Returns:

  • (String) 


230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 230

class AnomalyDetector < Struct.new(
  :anomaly_detector_id,
  :namespace,
  :metric_name,
  :dimensions,
  :stat,
  :configuration,
  :state_value,
  :metric_characteristics,
  :single_metric_anomaly_detector,
  :metric_math_anomaly_detector)
  SENSITIVE = []
  include Aws::Structure
end

#single_metric_anomaly_detector ⇒ Types::SingleMetricAnomalyDetector

The CloudWatch metric and statistic for this anomaly detector.

Returns:



230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 230

class AnomalyDetector < Struct.new(
  :anomaly_detector_id,
  :namespace,
  :metric_name,
  :dimensions,
  :stat,
  :configuration,
  :state_value,
  :metric_characteristics,
  :single_metric_anomaly_detector,
  :metric_math_anomaly_detector)
  SENSITIVE = []
  include Aws::Structure
end

#stat ⇒ String

The statistic associated with the anomaly detection model.

Returns:

  • (String) 


230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 230

class AnomalyDetector < Struct.new(
  :anomaly_detector_id,
  :namespace,
  :metric_name,
  :dimensions,
  :stat,
  :configuration,
  :state_value,
  :metric_characteristics,
  :single_metric_anomaly_detector,
  :metric_math_anomaly_detector)
  SENSITIVE = []
  include Aws::Structure
end

#state_value ⇒ String

The current status of the anomaly detector's training.

Returns:

  • (String) 


230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 230

class AnomalyDetector < Struct.new(
  :anomaly_detector_id,
  :namespace,
  :metric_name,
  :dimensions,
  :stat,
  :configuration,
  :state_value,
  :metric_characteristics,
  :single_metric_anomaly_detector,
  :metric_math_anomaly_detector)
  SENSITIVE = []
  include Aws::Structure
end