AnomalyDetectorConﬁguration

The conﬁguration speciﬁes 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.

ExcludedTimeRanges.member.N

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.

Type: Array of Range (p. 162) objects Required: No

MetricTimezone

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 speciﬁed in the standard tz database. For more information, see tz database.

Type: String

Length Constraints: Maximum length of 50.

Pattern: .*

Required: No

DashboardEntry

Represents a speciﬁc dashboard.

DashboardArn

The Amazon Resource Name (ARN) of the dashboard.

Type: String Required: No DashboardName

The name of the dashboard.

Type: String Required: No LastModiﬁed

The time stamp of when the dashboard was last modiﬁed, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Type: Timestamp Required: No Size

The size of the dashboard, in bytes.

Type: Long Required: No

Datapoint

Encapsulates the statistical data that CloudWatch computes from metric data.

Average

The average of the metric values that correspond to the data point.

Type: Double Required: No

ExtendedStatistics , ExtendedStatistics.entry.N.key (key) , ExtendedStatistics.entry.N.value (value) The percentile statistic for the data point.

Type: String to double map

Key Pattern: p(\d{1,2}(\.\d{0,2})?|100) Required: No

Maximum

The maximum metric value for the data point.

Type: Double Required: No Minimum

The minimum metric value for the data point.

Type: Double Required: No SampleCount

The number of metric values that contributed to the aggregate value of this data point.

Type: Double Required: No Sum

The sum of the metric values for the data point.

Type: Double Required: No Timestamp

The time stamp used for the data point.

Type: Timestamp Required: No

Dimension

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identiﬁer for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

You can assign up to 10 dimensions to a metric.

Name

The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes Value

The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

InsightRule

This structure contains the deﬁnition for a Contributor Insights rule. For more information about this rule, see Using Constributor Insights to analyze high-cardinality data in the Amazon CloudWatch User Guide.

Deﬁnition

The deﬁnition of the rule, as a JSON object. The deﬁnition contains the keywords used to deﬁne contributors, the value to aggregate on if this rule returns a sum instead of a count, and the ﬁlters.

For details on the valid syntax, see Contributor Insights Rule Syntax.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: [\x00-\x7F]+

Required: Yes Name

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\x20-\x7E]+

Required: Yes Schema

For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}

Type: String Required: Yes State

Indicates whether the rule is enabled or disabled.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [\x20-\x7E]+

Required: Yes

InsightRuleContributor

One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.

If the rule contains a single key, then each unique contributor is each unique value for this key.

For more information, see GetInsightRuleReport.

ApproximateAggregateValue

An approximation of the aggregate value that comes from this contributor.

Type: Double Required: Yes Datapoints.member.N

An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.

Type: Array of InsightRuleContributorDatapoint (p. 136) objects Required: Yes

Keys.member.N

One of the log entry ﬁeld keywords that is used to deﬁne contributors for this rule.

Type: Array of strings Required: Yes

InsightRuleMetricDatapoint

One data point from the metric time series returned in a Contributor Insights rule report.

For more information, see GetInsightRuleReport.

Average

The average value from all contributors during the time period represented by that data point.