You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudWatch::Types::AnomalyDetectorConfiguration

Inherits:

Struct

Object
Struct
Aws::CloudWatch::Types::AnomalyDetectorConfiguration

show all

Defined in:: gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

Note:

When making an API call, you may pass AnomalyDetectorConfiguration data as a hash:

{
  excluded_time_ranges: [
    {
      start_time: Time.now, # required
      end_time: Time.now, # required
    },
  ],
  metric_timezone: "AnomalyDetectorMetricTimezone",
}

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.

Instance Attribute Summary collapse

#excluded_time_ranges ⇒ Array<Types::Range>
An array of time ranges to exclude from use when the anomaly detection model is trained.
#metric_timezone ⇒ String
The time zone to use for the metric.

Instance Attribute Details

#excluded_time_ranges ⇒ `Array<Types::Range>`

An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates the model.

Returns:

(Array<Types::Range>)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 122

class AnomalyDetectorConfiguration < Struct.new(
  :excluded_time_ranges,
  :metric_timezone)
  include Aws::Structure
end

#metric_timezone ⇒ `String`

The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database.