# Data Types
<a name="API_Types"></a>

The Amazon CloudWatch API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [AlarmContributor](API_AlarmContributor.md) 
+  [AlarmHistoryItem](API_AlarmHistoryItem.md) 
+  [AlarmMuteRuleSummary](API_AlarmMuteRuleSummary.md) 
+  [AlarmPromQLCriteria](API_AlarmPromQLCriteria.md) 
+  [AnomalyDetector](API_AnomalyDetector.md) 
+  [AnomalyDetectorConfiguration](API_AnomalyDetectorConfiguration.md) 
+  [CompositeAlarm](API_CompositeAlarm.md) 
+  [DashboardEntry](API_DashboardEntry.md) 
+  [DashboardValidationMessage](API_DashboardValidationMessage.md) 
+  [Datapoint](API_Datapoint.md) 
+  [Dimension](API_Dimension.md) 
+  [DimensionFilter](API_DimensionFilter.md) 
+  [Entity](API_Entity.md) 
+  [EntityMetricData](API_EntityMetricData.md) 
+  [EvaluationCriteria](API_EvaluationCriteria.md) 
+  [InsightRule](API_InsightRule.md) 
+  [InsightRuleContributor](API_InsightRuleContributor.md) 
+  [InsightRuleContributorDatapoint](API_InsightRuleContributorDatapoint.md) 
+  [InsightRuleMetricDatapoint](API_InsightRuleMetricDatapoint.md) 
+  [LabelOptions](API_LabelOptions.md) 
+  [ManagedRule](API_ManagedRule.md) 
+  [ManagedRuleDescription](API_ManagedRuleDescription.md) 
+  [ManagedRuleState](API_ManagedRuleState.md) 
+  [MessageData](API_MessageData.md) 
+  [Metric](API_Metric.md) 
+  [MetricAlarm](API_MetricAlarm.md) 
+  [MetricCharacteristics](API_MetricCharacteristics.md) 
+  [MetricDataQuery](API_MetricDataQuery.md) 
+  [MetricDataResult](API_MetricDataResult.md) 
+  [MetricDatum](API_MetricDatum.md) 
+  [MetricMathAnomalyDetector](API_MetricMathAnomalyDetector.md) 
+  [MetricStat](API_MetricStat.md) 
+  [MetricStreamEntry](API_MetricStreamEntry.md) 
+  [MetricStreamFilter](API_MetricStreamFilter.md) 
+  [MetricStreamStatisticsConfiguration](API_MetricStreamStatisticsConfiguration.md) 
+  [MetricStreamStatisticsMetric](API_MetricStreamStatisticsMetric.md) 
+  [MuteTargets](API_MuteTargets.md) 
+  [PartialFailure](API_PartialFailure.md) 
+  [Range](API_Range.md) 
+  [Rule](API_Rule.md) 
+  [Schedule](API_Schedule.md) 
+  [SingleMetricAnomalyDetector](API_SingleMetricAnomalyDetector.md) 
+  [StatisticSet](API_StatisticSet.md) 
+  [Tag](API_Tag.md) 

# AlarmContributor
<a name="API_AlarmContributor"></a>

Represents an individual contributor to a multi-timeseries alarm, containing information about a specific time series and its contribution to the alarm's state.

## Contents
<a name="API_AlarmContributor_Contents"></a>

 ** ContributorAttributes **   <a name="ACW-Type-AlarmContributor-ContributorAttributes"></a>
A map of attributes that describe the contributor, such as metric dimensions and other identifying characteristics.  
Type: String to string map  
Map Entries: Maximum number of 30 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** ContributorId **   <a name="ACW-Type-AlarmContributor-ContributorId"></a>
The unique identifier for this alarm contributor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16.  
Required: Yes

 ** StateReason **   <a name="ACW-Type-AlarmContributor-StateReason"></a>
An explanation for the contributor's current state, providing context about why it is in its current condition.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1023.  
Required: Yes

 ** StateTransitionedTimestamp **   <a name="ACW-Type-AlarmContributor-StateTransitionedTimestamp"></a>
The timestamp when the contributor last transitioned to its current state.  
Type: Timestamp  
Required: No

## See Also
<a name="API_AlarmContributor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/AlarmContributor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/AlarmContributor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/AlarmContributor) 

# AlarmHistoryItem
<a name="API_AlarmHistoryItem"></a>

Represents the history of a specific alarm.

## Contents
<a name="API_AlarmHistoryItem_Contents"></a>

 ** AlarmContributorAttributes **   <a name="ACW-Type-AlarmHistoryItem-AlarmContributorAttributes"></a>
A map of attributes that describe the alarm contributor associated with this history item, providing context about the contributor's characteristics at the time of the event.  
Type: String to string map  
Map Entries: Maximum number of 30 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** AlarmContributorId **   <a name="ACW-Type-AlarmHistoryItem-AlarmContributorId"></a>
The unique identifier of the alarm contributor associated with this history item, if applicable.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16.  
Required: No

 ** AlarmName **   <a name="ACW-Type-AlarmHistoryItem-AlarmName"></a>
The descriptive name for the alarm.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** AlarmType **   <a name="ACW-Type-AlarmHistoryItem-AlarmType"></a>
The type of alarm, either metric alarm or composite alarm.  
Type: String  
Valid Values: `CompositeAlarm | MetricAlarm`   
Required: No

 ** HistoryData **   <a name="ACW-Type-AlarmHistoryItem-HistoryData"></a>
Data about the alarm, in JSON format.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4095.  
Required: No

 ** HistoryItemType **   <a name="ACW-Type-AlarmHistoryItem-HistoryItemType"></a>
The type of alarm history item.  
Type: String  
Valid Values: `ConfigurationUpdate | StateUpdate | Action | AlarmContributorStateUpdate | AlarmContributorAction`   
Required: No

 ** HistorySummary **   <a name="ACW-Type-AlarmHistoryItem-HistorySummary"></a>
A summary of the alarm history, in text format.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** Timestamp **   <a name="ACW-Type-AlarmHistoryItem-Timestamp"></a>
The time stamp for the alarm history item.  
Type: Timestamp  
Required: No

## See Also
<a name="API_AlarmHistoryItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/AlarmHistoryItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/AlarmHistoryItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/AlarmHistoryItem) 

# AlarmMuteRuleSummary
<a name="API_AlarmMuteRuleSummary"></a>

Summary information about an alarm mute rule, including its name, status, and configuration details.

## Contents
<a name="API_AlarmMuteRuleSummary_Contents"></a>

 ** AlarmMuteRuleArn **   <a name="ACW-Type-AlarmMuteRuleSummary-AlarmMuteRuleArn"></a>
The Amazon Resource Name (ARN) of the alarm mute rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: No

 ** ExpireDate **   <a name="ACW-Type-AlarmMuteRuleSummary-ExpireDate"></a>
The date and time when the mute rule expires and is no longer evaluated. This field is only present if an expiration date was configured.  
Type: Timestamp  
Required: No

 ** LastUpdatedTimestamp **   <a name="ACW-Type-AlarmMuteRuleSummary-LastUpdatedTimestamp"></a>
The date and time when the mute rule was last updated.  
Type: Timestamp  
Required: No

 ** MuteType **   <a name="ACW-Type-AlarmMuteRuleSummary-MuteType"></a>
Indicates whether the mute rule is one-time or recurring. Valid values are `ONE_TIME` or `RECURRING`.  
Type: String  
Required: No

 ** Status **   <a name="ACW-Type-AlarmMuteRuleSummary-Status"></a>
The current status of the alarm mute rule. Valid values are `SCHEDULED`, `ACTIVE`, or `EXPIRED`.  
Type: String  
Valid Values: `SCHEDULED | ACTIVE | EXPIRED`   
Required: No

## See Also
<a name="API_AlarmMuteRuleSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/AlarmMuteRuleSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/AlarmMuteRuleSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/AlarmMuteRuleSummary) 

# AlarmPromQLCriteria
<a name="API_AlarmPromQLCriteria"></a>

Contains the configuration that determines how a PromQL alarm evaluates its contributors, including the query to run and the durations that define when contributors transition between states.

## Contents
<a name="API_AlarmPromQLCriteria_Contents"></a>

 ** Query **   <a name="ACW-Type-AlarmPromQLCriteria-Query"></a>
The PromQL query that the alarm evaluates. The query must return a result of vector type. Each entry in the vector result represents an alarm contributor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10000.  
Required: Yes

 ** PendingPeriod **   <a name="ACW-Type-AlarmPromQLCriteria-PendingPeriod"></a>
The duration, in seconds, that a contributor must be continuously breaching before it transitions to the `ALARM` state.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 86400.  
Required: No

 ** RecoveryPeriod **   <a name="ACW-Type-AlarmPromQLCriteria-RecoveryPeriod"></a>
The duration, in seconds, that a contributor must continuously not be breaching before it transitions back to the `OK` state.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 86400.  
Required: No

## See Also
<a name="API_AlarmPromQLCriteria_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/AlarmPromQLCriteria) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/AlarmPromQLCriteria) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/AlarmPromQLCriteria) 

# AnomalyDetector
<a name="API_AnomalyDetector"></a>

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.

## Contents
<a name="API_AnomalyDetector_Contents"></a>

 ** Configuration **   <a name="ACW-Type-AnomalyDetector-Configuration"></a>
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.  
Type: [AnomalyDetectorConfiguration](API_AnomalyDetectorConfiguration.md) object  
Required: No

 ** Dimensions **   <a name="ACW-Type-AnomalyDetector-Dimensions"></a>
 *This member has been deprecated.*   
The metric dimensions associated with the anomaly detection model.  
Type: Array of [Dimension](API_Dimension.md) objects  
Array Members: Maximum number of 30 items.  
Required: No

 ** MetricCharacteristics **   <a name="ACW-Type-AnomalyDetector-MetricCharacteristics"></a>
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.  
Type: [MetricCharacteristics](API_MetricCharacteristics.md) object  
Required: No

 ** MetricMathAnomalyDetector **   <a name="ACW-Type-AnomalyDetector-MetricMathAnomalyDetector"></a>
The CloudWatch metric math expression for this anomaly detector.  
Type: [MetricMathAnomalyDetector](API_MetricMathAnomalyDetector.md) object  
Required: No

 ** MetricName **   <a name="ACW-Type-AnomalyDetector-MetricName"></a>
 *This member has been deprecated.*   
The name of the metric associated with the anomaly detection model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** Namespace **   <a name="ACW-Type-AnomalyDetector-Namespace"></a>
 *This member has been deprecated.*   
The namespace of the metric associated with the anomaly detection model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[^:].*`   
Required: No

 ** SingleMetricAnomalyDetector **   <a name="ACW-Type-AnomalyDetector-SingleMetricAnomalyDetector"></a>
The CloudWatch metric and statistic for this anomaly detector.  
Type: [SingleMetricAnomalyDetector](API_SingleMetricAnomalyDetector.md) object  
Required: No

 ** Stat **   <a name="ACW-Type-AnomalyDetector-Stat"></a>
 *This member has been deprecated.*   
The statistic associated with the anomaly detection model.  
Type: String  
Length Constraints: Maximum length of 50.  
Pattern: `(SampleCount|Average|Sum|Minimum|Maximum|IQM|(p|tc|tm|ts|wm)(\d{1,2}(\.\d{0,10})?|100)|[ou]\d+(\.\d*)?)(_E|_L|_H)?|(TM|TC|TS|WM)\(((((\d{1,2})(\.\d{0,10})?|100(\.0{0,10})?)%)?:((\d{1,2})(\.\d{0,10})?|100(\.0{0,10})?)%|((\d{1,2})(\.\d{0,10})?|100(\.0{0,10})?)%:(((\d{1,2})(\.\d{0,10})?|100(\.0{0,10})?)%)?)\)|(TM|TC|TS|WM|PR)\(((\d+(\.\d{0,10})?|(\d+(\.\d{0,10})?[Ee][+-]?\d+)):((\d+(\.\d{0,10})?|(\d+(\.\d{0,10})?[Ee][+-]?\d+)))?|((\d+(\.\d{0,10})?|(\d+(\.\d{0,10})?[Ee][+-]?\d+)))?:(\d+(\.\d{0,10})?|(\d+(\.\d{0,10})?[Ee][+-]?\d+)))\)`   
Required: No

 ** StateValue **   <a name="ACW-Type-AnomalyDetector-StateValue"></a>
The current status of the anomaly detector's training.  
Type: String  
Valid Values: `PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA | TRAINED`   
Required: No

## See Also
<a name="API_AnomalyDetector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/AnomalyDetector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/AnomalyDetector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/AnomalyDetector) 

# AnomalyDetectorConfiguration
<a name="API_AnomalyDetectorConfiguration"></a>

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.

## Contents
<a name="API_AnomalyDetectorConfiguration_Contents"></a>

 ** ExcludedTimeRanges **   <a name="ACW-Type-AnomalyDetectorConfiguration-ExcludedTimeRanges"></a>
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](API_Range.md) objects  
Required: No

 ** MetricTimezone **   <a name="ACW-Type-AnomalyDetectorConfiguration-MetricTimezone"></a>
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](https://en.wikipedia.org/wiki/Tz_database).  
Type: String  
Length Constraints: Maximum length of 50.  
Pattern: `.*`   
Required: No

## See Also
<a name="API_AnomalyDetectorConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/AnomalyDetectorConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/AnomalyDetectorConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/AnomalyDetectorConfiguration) 

# CompositeAlarm
<a name="API_CompositeAlarm"></a>

The details about a composite alarm.

## Contents
<a name="API_CompositeAlarm_Contents"></a>

 ** ActionsEnabled **   <a name="ACW-Type-CompositeAlarm-ActionsEnabled"></a>
Indicates whether actions should be executed during any changes to the alarm state.  
Type: Boolean  
Required: No

 ** ActionsSuppressedBy **   <a name="ACW-Type-CompositeAlarm-ActionsSuppressedBy"></a>
 When the value is `ALARM`, it means that the actions are suppressed because the suppressor alarm is in `ALARM` When the value is `WaitPeriod`, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the `ALARM` state. The maximum waiting time is as specified in `ActionsSuppressorWaitPeriod`. After this time, the composite alarm performs its actions. When the value is `ExtensionPeriod`, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of the `ALARM` state. The maximum waiting time is as specified in `ActionsSuppressorExtensionPeriod`. After this time, the composite alarm performs its actions.   
Type: String  
Valid Values: `WaitPeriod | ExtensionPeriod | Alarm`   
Required: No

 ** ActionsSuppressedReason **   <a name="ACW-Type-CompositeAlarm-ActionsSuppressedReason"></a>
 Captures the reason for action suppression.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** ActionsSuppressor **   <a name="ACW-Type-CompositeAlarm-ActionsSuppressor"></a>
 Actions will be suppressed if the suppressor alarm is in the `ALARM` state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: No

 ** ActionsSuppressorExtensionPeriod **   <a name="ACW-Type-CompositeAlarm-ActionsSuppressorExtensionPeriod"></a>
 The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state. After this time, the composite alarm performs its actions.   
 `ExtensionPeriod` is required only when `ActionsSuppressor` is specified. 
Type: Integer  
Required: No

 ** ActionsSuppressorWaitPeriod **   <a name="ACW-Type-CompositeAlarm-ActionsSuppressorWaitPeriod"></a>
 The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state. After this time, the composite alarm performs its actions.   
 `WaitPeriod` is required only when `ActionsSuppressor` is specified. 
Type: Integer  
Required: No

 ** AlarmActions **   <a name="ACW-Type-CompositeAlarm-AlarmActions"></a>
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** AlarmArn **   <a name="ACW-Type-CompositeAlarm-AlarmArn"></a>
The Amazon Resource Name (ARN) of the alarm.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: No

 ** AlarmConfigurationUpdatedTimestamp **   <a name="ACW-Type-CompositeAlarm-AlarmConfigurationUpdatedTimestamp"></a>
The time stamp of the last update to the alarm configuration.  
Type: Timestamp  
Required: No

 ** AlarmDescription **   <a name="ACW-Type-CompositeAlarm-AlarmDescription"></a>
The description of the alarm.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** AlarmName **   <a name="ACW-Type-CompositeAlarm-AlarmName"></a>
The name of the alarm.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** AlarmRule **   <a name="ACW-Type-CompositeAlarm-AlarmRule"></a>
The rule that this alarm uses to evaluate its alarm state.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10240.  
Required: No

 ** InsufficientDataActions **   <a name="ACW-Type-CompositeAlarm-InsufficientDataActions"></a>
The actions to execute when this alarm transitions to the INSUFFICIENT\$1DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** OKActions **   <a name="ACW-Type-CompositeAlarm-OKActions"></a>
The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StateReason **   <a name="ACW-Type-CompositeAlarm-StateReason"></a>
An explanation for the alarm state, in text format.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1023.  
Required: No

 ** StateReasonData **   <a name="ACW-Type-CompositeAlarm-StateReasonData"></a>
An explanation for the alarm state, in JSON format.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4000.  
Required: No

 ** StateTransitionedTimestamp **   <a name="ACW-Type-CompositeAlarm-StateTransitionedTimestamp"></a>
 The timestamp of the last change to the alarm's `StateValue`.   
Type: Timestamp  
Required: No

 ** StateUpdatedTimestamp **   <a name="ACW-Type-CompositeAlarm-StateUpdatedTimestamp"></a>
Tracks the timestamp of any state update, even if `StateValue` doesn't change.  
Type: Timestamp  
Required: No

 ** StateValue **   <a name="ACW-Type-CompositeAlarm-StateValue"></a>
The state value for the alarm.  
Type: String  
Valid Values: `OK | ALARM | INSUFFICIENT_DATA`   
Required: No

## See Also
<a name="API_CompositeAlarm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/CompositeAlarm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/CompositeAlarm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/CompositeAlarm) 

# DashboardEntry
<a name="API_DashboardEntry"></a>

Represents a specific dashboard.

## Contents
<a name="API_DashboardEntry_Contents"></a>

 ** DashboardArn **   <a name="ACW-Type-DashboardEntry-DashboardArn"></a>
The Amazon Resource Name (ARN) of the dashboard.  
Type: String  
Required: No

 ** DashboardName **   <a name="ACW-Type-DashboardEntry-DashboardName"></a>
The name of the dashboard.  
Type: String  
Required: No

 ** LastModified **   <a name="ACW-Type-DashboardEntry-LastModified"></a>
The time stamp of when the dashboard was last modified, 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 **   <a name="ACW-Type-DashboardEntry-Size"></a>
The size of the dashboard, in bytes.  
Type: Long  
Required: No

## See Also
<a name="API_DashboardEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/DashboardEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DashboardEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/DashboardEntry) 

# DashboardValidationMessage
<a name="API_DashboardValidationMessage"></a>

An error or warning for the operation.

## Contents
<a name="API_DashboardValidationMessage_Contents"></a>

 ** DataPath **   <a name="ACW-Type-DashboardValidationMessage-DataPath"></a>
The data path related to the message.  
Type: String  
Required: No

 ** Message **   <a name="ACW-Type-DashboardValidationMessage-Message"></a>
A message describing the error or warning.  
Type: String  
Required: No

## See Also
<a name="API_DashboardValidationMessage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/DashboardValidationMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DashboardValidationMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/DashboardValidationMessage) 

# Datapoint
<a name="API_Datapoint"></a>

Encapsulates the statistical data that CloudWatch computes from metric data.

## Contents
<a name="API_Datapoint_Contents"></a>

 ** Average **   <a name="ACW-Type-Datapoint-Average"></a>
The average of the metric values that correspond to the data point.  
Type: Double  
Required: No

 ** ExtendedStatistics **   <a name="ACW-Type-Datapoint-ExtendedStatistics"></a>
The percentile statistic for the data point.  
Type: String to double map  
Required: No

 ** Maximum **   <a name="ACW-Type-Datapoint-Maximum"></a>
The maximum metric value for the data point.  
Type: Double  
Required: No

 ** Minimum **   <a name="ACW-Type-Datapoint-Minimum"></a>
The minimum metric value for the data point.  
Type: Double  
Required: No

 ** SampleCount **   <a name="ACW-Type-Datapoint-SampleCount"></a>
The number of metric values that contributed to the aggregate value of this data point.  
Type: Double  
Required: No

 ** Sum **   <a name="ACW-Type-Datapoint-Sum"></a>
The sum of the metric values for the data point.  
Type: Double  
Required: No

 ** Timestamp **   <a name="ACW-Type-Datapoint-Timestamp"></a>
The time stamp used for the data point.  
Type: Timestamp  
Required: No

 ** Unit **   <a name="ACW-Type-Datapoint-Unit"></a>
The standard unit for the data point.  
Type: String  
Valid Values: `Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None`   
Required: No

## See Also
<a name="API_Datapoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/Datapoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/Datapoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/Datapoint) 

# Dimension
<a name="API_Dimension"></a>

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier 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 30 dimensions to a metric.

## Contents
<a name="API_Dimension_Contents"></a>

 ** Name **   <a name="ACW-Type-Dimension-Name"></a>
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 (`:`). ASCII control characters are not supported as part of dimension names.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** Value **   <a name="ACW-Type-Dimension-Value"></a>
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

## See Also
<a name="API_Dimension_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/Dimension) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/Dimension) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/Dimension) 

# DimensionFilter
<a name="API_DimensionFilter"></a>

Represents filters for a dimension.

## Contents
<a name="API_DimensionFilter_Contents"></a>

 ** Name **   <a name="ACW-Type-DimensionFilter-Name"></a>
The dimension name to be matched.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** Value **   <a name="ACW-Type-DimensionFilter-Value"></a>
The value of the dimension to be matched.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_DimensionFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/DimensionFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DimensionFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/DimensionFilter) 

# Entity
<a name="API_Entity"></a>

An entity associated with metrics, to allow for finding related telemetry. An entity is typically a resource or service within your system. For example, metrics from an Amazon EC2 instance could be associated with that instance as the entity. Similarly, metrics from a service that you own could be associated with that service as the entity.

## Contents
<a name="API_Entity_Contents"></a>

 ** Attributes **   <a name="ACW-Type-Entity-Attributes"></a>
Additional attributes of the entity that are not used to specify the identity of the entity. A list of key-value pairs.  
For details about how to use the attributes, see [How to add related information to telemetry](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html) in the *CloudWatch User Guide*.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Value Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** KeyAttributes **   <a name="ACW-Type-Entity-KeyAttributes"></a>
The attributes of the entity which identify the specific entity, as a list of key-value pairs. Entities with the same `KeyAttributes` are considered to be the same entity. For an entity to be valid, the `KeyAttributes` must exist and be formatted correctly.  
There are five allowed attributes (key names): `Type`, `ResourceType`, `Identifier`, `Name`, and `Environment`.  
For details about how to use the key attributes to specify an entity, see [How to add related information to telemetry](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html) in the *CloudWatch User Guide*.  
Type: String to string map  
Map Entries: Minimum number of 2 items. Maximum number of 4 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 32.  
Value Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_Entity_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/Entity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/Entity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/Entity) 

# EntityMetricData
<a name="API_EntityMetricData"></a>

A set of metrics that are associated with an entity, such as a specific service or resource. Contains the entity and the list of metric data associated with it.

## Contents
<a name="API_EntityMetricData_Contents"></a>

 ** Entity **   <a name="ACW-Type-EntityMetricData-Entity"></a>
The entity associated with the metrics.  
Type: [Entity](API_Entity.md) object  
Required: No

 ** MetricData **   <a name="ACW-Type-EntityMetricData-MetricData"></a>
The metric data.  
Type: Array of [MetricDatum](API_MetricDatum.md) objects  
Required: No

## See Also
<a name="API_EntityMetricData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/EntityMetricData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/EntityMetricData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/EntityMetricData) 

# EvaluationCriteria
<a name="API_EvaluationCriteria"></a>

The evaluation criteria for an alarm. This is a union type that currently supports `PromQLCriteria`.

## Contents
<a name="API_EvaluationCriteria_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** PromQLCriteria **   <a name="ACW-Type-EvaluationCriteria-PromQLCriteria"></a>
The PromQL criteria for the alarm evaluation.  
Type: [AlarmPromQLCriteria](API_AlarmPromQLCriteria.md) object  
Required: No

## See Also
<a name="API_EvaluationCriteria_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/EvaluationCriteria) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/EvaluationCriteria) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/EvaluationCriteria) 

# InsightRule
<a name="API_InsightRule"></a>

This structure contains the definition for a Contributor Insights rule. For more information about this rule, see[ Using Constributor Insights to analyze high-cardinality data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) in the *Amazon CloudWatch User Guide*.

## Contents
<a name="API_InsightRule_Contents"></a>

 ** Definition **   <a name="ACW-Type-InsightRule-Definition"></a>
The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see [Contributor Insights Rule Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Pattern: `[\x00-\x7F]+`   
Required: Yes

 ** Name **   <a name="ACW-Type-InsightRule-Name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x20-\x7E]+`   
Required: Yes

 ** Schema **   <a name="ACW-Type-InsightRule-Schema"></a>
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 **   <a name="ACW-Type-InsightRule-State"></a>
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

 ** ApplyOnTransformedLogs **   <a name="ACW-Type-InsightRule-ApplyOnTransformedLogs"></a>
Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have [Log transformation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html) enabled. If this is `false`, log events are evaluated before they are transformed.  
Type: Boolean  
Required: No

 ** ManagedRule **   <a name="ACW-Type-InsightRule-ManagedRule"></a>
 An optional built-in rule that AWS manages.   
Type: Boolean  
Required: No

## See Also
<a name="API_InsightRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/InsightRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/InsightRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/InsightRule) 

# InsightRuleContributor
<a name="API_InsightRuleContributor"></a>

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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html).

## Contents
<a name="API_InsightRuleContributor_Contents"></a>

 ** ApproximateAggregateValue **   <a name="ACW-Type-InsightRuleContributor-ApproximateAggregateValue"></a>
An approximation of the aggregate value that comes from this contributor.  
Type: Double  
Required: Yes

 ** Datapoints **   <a name="ACW-Type-InsightRuleContributor-Datapoints"></a>
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](API_InsightRuleContributorDatapoint.md) objects  
Required: Yes

 ** Keys **   <a name="ACW-Type-InsightRuleContributor-Keys"></a>
One of the log entry field keywords that is used to define contributors for this rule.  
Type: Array of strings  
Required: Yes

## See Also
<a name="API_InsightRuleContributor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/InsightRuleContributor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/InsightRuleContributor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/InsightRuleContributor) 

# InsightRuleContributorDatapoint
<a name="API_InsightRuleContributorDatapoint"></a>

One data point related to one contributor.

For more information, see [GetInsightRuleReport](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html) and [InsightRuleContributor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html).

## Contents
<a name="API_InsightRuleContributorDatapoint_Contents"></a>

 ** ApproximateValue **   <a name="ACW-Type-InsightRuleContributorDatapoint-ApproximateValue"></a>
The approximate value that this contributor added during this timestamp.  
Type: Double  
Required: Yes

 ** Timestamp **   <a name="ACW-Type-InsightRuleContributorDatapoint-Timestamp"></a>
The timestamp of the data point.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_InsightRuleContributorDatapoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/InsightRuleContributorDatapoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/InsightRuleContributorDatapoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/InsightRuleContributorDatapoint) 

# InsightRuleMetricDatapoint
<a name="API_InsightRuleMetricDatapoint"></a>

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

For more information, see [GetInsightRuleReport](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html).

## Contents
<a name="API_InsightRuleMetricDatapoint_Contents"></a>

 ** Timestamp **   <a name="ACW-Type-InsightRuleMetricDatapoint-Timestamp"></a>
The timestamp of the data point.  
Type: Timestamp  
Required: Yes

 ** Average **   <a name="ACW-Type-InsightRuleMetricDatapoint-Average"></a>
The average value from all contributors during the time period represented by that data point.  
This statistic is returned only if you included it in the `Metrics` array in your request.  
Type: Double  
Required: No

 ** MaxContributorValue **   <a name="ACW-Type-InsightRuleMetricDatapoint-MaxContributorValue"></a>
The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, so the identity of the max contributor could be different for each timestamp.  
This statistic is returned only if you included it in the `Metrics` array in your request.  
Type: Double  
Required: No

 ** Maximum **   <a name="ACW-Type-InsightRuleMetricDatapoint-Maximum"></a>
The maximum value from a single occurence from a single contributor during the time period represented by that data point.  
This statistic is returned only if you included it in the `Metrics` array in your request.  
Type: Double  
Required: No

 ** Minimum **   <a name="ACW-Type-InsightRuleMetricDatapoint-Minimum"></a>
The minimum value from a single contributor during the time period represented by that data point.  
This statistic is returned only if you included it in the `Metrics` array in your request.  
Type: Double  
Required: No

 ** SampleCount **   <a name="ACW-Type-InsightRuleMetricDatapoint-SampleCount"></a>
The number of occurrences that matched the rule during this data point.  
This statistic is returned only if you included it in the `Metrics` array in your request.  
Type: Double  
Required: No

 ** Sum **   <a name="ACW-Type-InsightRuleMetricDatapoint-Sum"></a>
The sum of the values from all contributors during the time period represented by that data point.  
This statistic is returned only if you included it in the `Metrics` array in your request.  
Type: Double  
Required: No

 ** UniqueContributors **   <a name="ACW-Type-InsightRuleMetricDatapoint-UniqueContributors"></a>
The number of unique contributors who published data during this timestamp.  
This statistic is returned only if you included it in the `Metrics` array in your request.  
Type: Double  
Required: No

## See Also
<a name="API_InsightRuleMetricDatapoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/InsightRuleMetricDatapoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/InsightRuleMetricDatapoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/InsightRuleMetricDatapoint) 

# LabelOptions
<a name="API_LabelOptions"></a>

This structure includes the `Timezone` parameter, which you can use to specify your time zone so that the labels that are associated with returned metrics display the correct time for your time zone. 

The `Timezone` value affects a label only if you have a time-based dynamic expression in the label. For more information about dynamic expressions in labels, see [Using Dynamic Labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html).

## Contents
<a name="API_LabelOptions_Contents"></a>

 ** Timezone **   <a name="ACW-Type-LabelOptions-Timezone"></a>
The time zone to use for metric data return in this operation. The format is `+` or `-` followed by four digits. The first two digits indicate the number of hours ahead or behind of UTC, and the final two digits are the number of minutes. For example, \$10130 indicates a time zone that is 1 hour and 30 minutes ahead of UTC. The default is \$10000.   
Type: String  
Required: No

## See Also
<a name="API_LabelOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/LabelOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/LabelOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/LabelOptions) 

# ManagedRule
<a name="API_ManagedRule"></a>

 Contains the information that's required to enable a managed Contributor Insights rule for an AWS resource. 

## Contents
<a name="API_ManagedRule_Contents"></a>

 ** ResourceARN **   <a name="ACW-Type-ManagedRule-ResourceARN"></a>
 The ARN of an AWS resource that has managed Contributor Insights rules.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** TemplateName **   <a name="ACW-Type-ManagedRule-TemplateName"></a>
 The template name for the managed Contributor Insights rule, as returned by `ListManagedInsightRules`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[0-9A-Za-z][\-\.\_0-9A-Za-z]{0,126}[0-9A-Za-z]`   
Required: Yes

 ** Tags **   <a name="ACW-Type-ManagedRule-Tags"></a>
 A list of key-value pairs that you can associate with a managed Contributor Insights rule. You can associate as many as 50 tags with a rule. Tags can help you organize and categorize your resources. You also can use them to scope user permissions by granting a user permission to access or change only the resources that have certain tag values. To associate tags with a rule, you must have the `cloudwatch:TagResource` permission in addition to the `cloudwatch:PutInsightRule` permission. If you are using this operation to update an existing Contributor Insights rule, any tags that you specify in this parameter are ignored. To change the tags of an existing rule, use `TagResource`.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_ManagedRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/ManagedRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/ManagedRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/ManagedRule) 

# ManagedRuleDescription
<a name="API_ManagedRuleDescription"></a>

 Contains information about managed Contributor Insights rules, as returned by `ListManagedInsightRules`. 

## Contents
<a name="API_ManagedRuleDescription_Contents"></a>

 ** ResourceARN **   <a name="ACW-Type-ManagedRuleDescription-ResourceARN"></a>
 If a managed rule is enabled, this is the ARN for the related AWS resource.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** RuleState **   <a name="ACW-Type-ManagedRuleDescription-RuleState"></a>
 Describes the state of a managed rule. If present, it contains information about the Contributor Insights rule that contains information about the related AWS resource.   
Type: [ManagedRuleState](API_ManagedRuleState.md) object  
Required: No

 ** TemplateName **   <a name="ACW-Type-ManagedRuleDescription-TemplateName"></a>
 The template name for the managed rule. Used to enable managed rules using `PutManagedInsightRules`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[0-9A-Za-z][\-\.\_0-9A-Za-z]{0,126}[0-9A-Za-z]`   
Required: No

## See Also
<a name="API_ManagedRuleDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/ManagedRuleDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/ManagedRuleDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/ManagedRuleDescription) 

# ManagedRuleState
<a name="API_ManagedRuleState"></a>

 The status of a managed Contributor Insights rule. 

## Contents
<a name="API_ManagedRuleState_Contents"></a>

 ** RuleName **   <a name="ACW-Type-ManagedRuleState-RuleName"></a>
 The name of the Contributor Insights rule that contains data for the specified AWS resource.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x20-\x7E]+`   
Required: Yes

 ** State **   <a name="ACW-Type-ManagedRuleState-State"></a>
 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

## See Also
<a name="API_ManagedRuleState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/ManagedRuleState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/ManagedRuleState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/ManagedRuleState) 

# MessageData
<a name="API_MessageData"></a>

A message returned by the `GetMetricData`API, including a code and a description.

If a cross-Region `GetMetricData` operation fails with a code of `Forbidden` and a value of `Authentication too complex to retrieve cross region data`, you can correct the problem by running the `GetMetricData` operation in the same Region where the metric data is.

## Contents
<a name="API_MessageData_Contents"></a>

 ** Code **   <a name="ACW-Type-MessageData-Code"></a>
The error code or status code associated with the message.  
Type: String  
Required: No

 ** Value **   <a name="ACW-Type-MessageData-Value"></a>
The message text.  
Type: String  
Required: No

## See Also
<a name="API_MessageData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MessageData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MessageData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MessageData) 

# Metric
<a name="API_Metric"></a>

Represents a specific metric.

## Contents
<a name="API_Metric_Contents"></a>

 ** Dimensions **   <a name="ACW-Type-Metric-Dimensions"></a>
The dimensions for the metric.  
Type: Array of [Dimension](API_Dimension.md) objects  
Array Members: Maximum number of 30 items.  
Required: No

 ** MetricName **   <a name="ACW-Type-Metric-MetricName"></a>
The name of the metric. This is a required field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** Namespace **   <a name="ACW-Type-Metric-Namespace"></a>
The namespace of the metric.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[^:].*`   
Required: No

## See Also
<a name="API_Metric_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/Metric) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/Metric) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/Metric) 

# MetricAlarm
<a name="API_MetricAlarm"></a>

The details about a metric alarm.

## Contents
<a name="API_MetricAlarm_Contents"></a>

 ** ActionsEnabled **   <a name="ACW-Type-MetricAlarm-ActionsEnabled"></a>
Indicates whether actions should be executed during any changes to the alarm state.  
Type: Boolean  
Required: No

 ** AlarmActions **   <a name="ACW-Type-MetricAlarm-AlarmActions"></a>
The actions to execute when this alarm transitions to the `ALARM` state from any other state. Each action is specified as an Amazon Resource Name (ARN).  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** AlarmArn **   <a name="ACW-Type-MetricAlarm-AlarmArn"></a>
The Amazon Resource Name (ARN) of the alarm.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: No

 ** AlarmConfigurationUpdatedTimestamp **   <a name="ACW-Type-MetricAlarm-AlarmConfigurationUpdatedTimestamp"></a>
The time stamp of the last update to the alarm configuration.  
Type: Timestamp  
Required: No

 ** AlarmDescription **   <a name="ACW-Type-MetricAlarm-AlarmDescription"></a>
The description of the alarm.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** AlarmName **   <a name="ACW-Type-MetricAlarm-AlarmName"></a>
The name of the alarm.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** ComparisonOperator **   <a name="ACW-Type-MetricAlarm-ComparisonOperator"></a>
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.  
Type: String  
Valid Values: `GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold | LessThanLowerOrGreaterThanUpperThreshold | LessThanLowerThreshold | GreaterThanUpperThreshold`   
Required: No

 ** DatapointsToAlarm **   <a name="ACW-Type-MetricAlarm-DatapointsToAlarm"></a>
The number of data points that must be breaching to trigger the alarm.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** Dimensions **   <a name="ACW-Type-MetricAlarm-Dimensions"></a>
The dimensions for the metric associated with the alarm.  
Type: Array of [Dimension](API_Dimension.md) objects  
Array Members: Maximum number of 30 items.  
Required: No

 ** EvaluateLowSampleCountPercentile **   <a name="ACW-Type-MetricAlarm-EvaluateLowSampleCountPercentile"></a>
Used only for alarms based on percentiles. If `ignore`, the alarm state does not change during periods with too few data points to be statistically significant. If `evaluate` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** EvaluationCriteria **   <a name="ACW-Type-MetricAlarm-EvaluationCriteria"></a>
The evaluation criteria for the alarm.  
Type: [EvaluationCriteria](API_EvaluationCriteria.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** EvaluationInterval **   <a name="ACW-Type-MetricAlarm-EvaluationInterval"></a>
The frequency, in seconds, at which the alarm is evaluated.  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 3600.  
Required: No

 ** EvaluationPeriods **   <a name="ACW-Type-MetricAlarm-EvaluationPeriods"></a>
The number of periods over which data is compared to the specified threshold.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** EvaluationState **   <a name="ACW-Type-MetricAlarm-EvaluationState"></a>
If the value of this field is `PARTIAL_DATA`, it indicates that not all the available data was able to be retrieved due to quota limitations. For more information, see [Create alarms on Metrics Insights queries](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html).  
If the value of this field is `EVALUATION_ERROR`, it indicates configuration errors in alarm setup that require review and correction. Refer to StateReason field of the alarm for more details.  
If the value of this field is `EVALUATION_FAILURE`, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved   
Type: String  
Valid Values: `PARTIAL_DATA | EVALUATION_FAILURE | EVALUATION_ERROR`   
Required: No

 ** ExtendedStatistic **   <a name="ACW-Type-MetricAlarm-ExtendedStatistic"></a>
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.  
Type: String  
Required: No

 ** InsufficientDataActions **   <a name="ACW-Type-MetricAlarm-InsufficientDataActions"></a>
The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state. Each action is specified as an Amazon Resource Name (ARN).  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** MetricName **   <a name="ACW-Type-MetricAlarm-MetricName"></a>
The name of the metric associated with the alarm, if this is an alarm based on a single metric.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** Metrics **   <a name="ACW-Type-MetricAlarm-Metrics"></a>
An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having `ReturnData` set to true.  
Type: Array of [MetricDataQuery](API_MetricDataQuery.md) objects  
Required: No

 ** Namespace **   <a name="ACW-Type-MetricAlarm-Namespace"></a>
The namespace of the metric associated with the alarm.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[^:].*`   
Required: No

 ** OKActions **   <a name="ACW-Type-MetricAlarm-OKActions"></a>
The actions to execute when this alarm transitions to the `OK` state from any other state. Each action is specified as an Amazon Resource Name (ARN).  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** Period **   <a name="ACW-Type-MetricAlarm-Period"></a>
The period, in seconds, over which the statistic is applied.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** StateReason **   <a name="ACW-Type-MetricAlarm-StateReason"></a>
An explanation for the alarm state, in text format.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1023.  
Required: No

 ** StateReasonData **   <a name="ACW-Type-MetricAlarm-StateReasonData"></a>
An explanation for the alarm state, in JSON format.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4000.  
Required: No

 ** StateTransitionedTimestamp **   <a name="ACW-Type-MetricAlarm-StateTransitionedTimestamp"></a>
The date and time that the alarm's `StateValue` most recently changed.  
Type: Timestamp  
Required: No

 ** StateUpdatedTimestamp **   <a name="ACW-Type-MetricAlarm-StateUpdatedTimestamp"></a>
The time stamp of the last update to the value of either the `StateValue` or `EvaluationState` parameters.  
Type: Timestamp  
Required: No

 ** StateValue **   <a name="ACW-Type-MetricAlarm-StateValue"></a>
The state value for the alarm.  
Type: String  
Valid Values: `OK | ALARM | INSUFFICIENT_DATA`   
Required: No

 ** Statistic **   <a name="ACW-Type-MetricAlarm-Statistic"></a>
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use `ExtendedStatistic`.  
Type: String  
Valid Values: `SampleCount | Average | Sum | Minimum | Maximum`   
Required: No

 ** Threshold **   <a name="ACW-Type-MetricAlarm-Threshold"></a>
The value to compare with the specified statistic.  
Type: Double  
Required: No

 ** ThresholdMetricId **   <a name="ACW-Type-MetricAlarm-ThresholdMetricId"></a>
In an alarm based on an anomaly detection model, this is the ID of the `ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** TreatMissingData **   <a name="ACW-Type-MetricAlarm-TreatMissingData"></a>
Sets how this alarm is to handle missing data points. The valid values are `breaching`, `notBreaching`, `ignore`, and `missing`. For more information, see [Configuring how CloudWatch alarms treat missing data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data).  
If this parameter is omitted, the default behavior of `missing` is used.  
This parameter is not applicable to PromQL alarms.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** Unit **   <a name="ACW-Type-MetricAlarm-Unit"></a>
The unit of the metric associated with the alarm.  
Type: String  
Valid Values: `Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None`   
Required: No

## See Also
<a name="API_MetricAlarm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MetricAlarm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MetricAlarm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MetricAlarm) 

# MetricCharacteristics
<a name="API_MetricCharacteristics"></a>

This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.

## Contents
<a name="API_MetricCharacteristics_Contents"></a>

 ** PeriodicSpikes **   <a name="ACW-Type-MetricCharacteristics-PeriodicSpikes"></a>
Set this parameter to `true` if values for this metric consistently include spikes that should not be considered to be anomalies. With this set to `true`, CloudWatch will expect to see spikes that occurred consistently during the model training period, and won't flag future similar spikes as anomalies.  
Type: Boolean  
Required: No

## See Also
<a name="API_MetricCharacteristics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MetricCharacteristics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MetricCharacteristics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MetricCharacteristics) 

# MetricDataQuery
<a name="API_MetricDataQuery"></a>

This structure is used in both `GetMetricData` and `PutMetricAlarm`. The supported use of this structure is different for those two operations.

When used in `GetMetricData`, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single `GetMetricData` call can include up to 500 `MetricDataQuery` structures.

When used in `PutMetricAlarm`, it enables you to create an alarm based on a metric math expression. Each `MetricDataQuery` in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single `PutMetricAlarm` call can include up to 20 `MetricDataQuery` structures in the array. The 20 structures can include as many as 10 structures that contain a `MetricStat` parameter to retrieve a metric, and as many as 10 structures that contain the `Expression` parameter to perform a math expression. Of those `Expression` structures, one must have `true` as the value for `ReturnData`. The result of this expression is the value the alarm watches.

Any expression used in a `PutMetricAlarm` operation must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*.

Some of the parameters of this structure also have different uses whether you are using this structure in a `GetMetricData` operation or a `PutMetricAlarm` operation. These differences are explained in the following parameter list.

## Contents
<a name="API_MetricDataQuery_Contents"></a>

 ** Id **   <a name="ACW-Type-MetricDataQuery-Id"></a>
A short name used to tie this object to the results in the response. This name must be unique within a single call to `GetMetricData`. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** AccountId **   <a name="ACW-Type-MetricDataQuery-AccountId"></a>
The ID of the account where the metrics are located.  
If you are performing a `GetMetricData` operation in a monitoring account, use this to specify which account to retrieve this metric from.  
If you are performing a `PutMetricAlarm` operation, use this to specify which account contains the metric that the alarm is watching.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** Expression **   <a name="ACW-Type-MetricDataQuery-Expression"></a>
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see [Metrics Insights query components and syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) in the *Amazon CloudWatch User Guide*.  
A math expression can use the `Id` of the other metrics or queries to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*.  
Within each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** Label **   <a name="ACW-Type-MetricDataQuery-Label"></a>
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.  
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see [Using Dynamic Labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html).  
Type: String  
Required: No

 ** MetricStat **   <a name="ACW-Type-MetricDataQuery-MetricStat"></a>
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.  
Within one MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.  
Type: [MetricStat](API_MetricStat.md) object  
Required: No

 ** Period **   <a name="ACW-Type-MetricDataQuery-Period"></a>
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a `PutMetricData` operation that includes a `StorageResolution of 1 second`.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** ReturnData **   <a name="ACW-Type-MetricDataQuery-ReturnData"></a>
When used in `GetMetricData`, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify `false`. If you omit this, the default of `true` is used.  
When used in `PutMetricAlarm`, specify `true` for the one expression result to use as the alarm. For all other metrics and expressions in the same `PutMetricAlarm` operation, specify `ReturnData` as False.  
Type: Boolean  
Required: No

## See Also
<a name="API_MetricDataQuery_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MetricDataQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MetricDataQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MetricDataQuery) 

# MetricDataResult
<a name="API_MetricDataResult"></a>

A `GetMetricData` call returns an array of `MetricDataResult` structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.

## Contents
<a name="API_MetricDataResult_Contents"></a>

 ** Id **   <a name="ACW-Type-MetricDataResult-Id"></a>
The short name you specified to represent this metric.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** Label **   <a name="ACW-Type-MetricDataResult-Label"></a>
The human-readable label associated with the data.  
Type: String  
Required: No

 ** Messages **   <a name="ACW-Type-MetricDataResult-Messages"></a>
A list of messages with additional information about the data returned.  
Type: Array of [MessageData](API_MessageData.md) objects  
Required: No

 ** StatusCode **   <a name="ACW-Type-MetricDataResult-StatusCode"></a>
The status of the returned data. `Complete` indicates that all data points in the requested time range were returned. `PartialData` means that an incomplete set of data points were returned. You can use the `NextToken` value that was returned and repeat your request to get more data points. `NextToken` is not returned if you are performing a math expression. `InternalError` indicates that an error occurred. Retry your request using `NextToken`, if present.  
Type: String  
Valid Values: `Complete | InternalError | PartialData | Forbidden`   
Required: No

 ** Timestamps **   <a name="ACW-Type-MetricDataResult-Timestamps"></a>
The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].  
Type: Array of timestamps  
Required: No

 ** Values **   <a name="ACW-Type-MetricDataResult-Values"></a>
The data points for the metric corresponding to `Timestamps`. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].  
Type: Array of doubles  
Required: No

## See Also
<a name="API_MetricDataResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MetricDataResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MetricDataResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MetricDataResult) 

# MetricDatum
<a name="API_MetricDatum"></a>

Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.

## Contents
<a name="API_MetricDatum_Contents"></a>

 ** MetricName **   <a name="ACW-Type-MetricDatum-MetricName"></a>
The name of the metric.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** Counts **   <a name="ACW-Type-MetricDatum-Counts"></a>
Array of numbers that is used along with the `Values` array. Each number in the `Count` array is the number of times the corresponding value in the `Values` array occurred during the period.   
If you omit the `Counts` array, the default of 1 is used as the value for each count. If you include a `Counts` array, it must include the same amount of values as the `Values` array.  
Type: Array of doubles  
Required: No

 ** Dimensions **   <a name="ACW-Type-MetricDatum-Dimensions"></a>
The dimensions associated with the metric.   
Type: Array of [Dimension](API_Dimension.md) objects  
Array Members: Maximum number of 30 items.  
Required: No

 ** StatisticValues **   <a name="ACW-Type-MetricDatum-StatisticValues"></a>
The statistical values for the metric.  
Type: [StatisticSet](API_StatisticSet.md) object  
Required: No

 ** StorageResolution **   <a name="ACW-Type-MetricDatum-StorageResolution"></a>
Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see [High-Resolution Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics) in the *Amazon CloudWatch User Guide*.   
This field is optional, if you do not specify it the default of 60 is used.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** Timestamp **   <a name="ACW-Type-MetricDatum-Timestamp"></a>
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.  
Type: Timestamp  
Required: No

 ** Unit **   <a name="ACW-Type-MetricDatum-Unit"></a>
When you are using a `Put` operation, this defines what unit you want to use when storing the metric.  
In a `Get` operation, this displays the unit that is used for the metric.  
Type: String  
Valid Values: `Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None`   
Required: No

 ** Value **   <a name="ACW-Type-MetricDatum-Value"></a>
The value for the metric.  
Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, \$1Infinity, -Infinity) are not supported.  
Type: Double  
Required: No

 ** Values **   <a name="ACW-Type-MetricDatum-Values"></a>
Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the `Counts` array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each `PutMetricData` action that specifies a `Values` array.  
Although the `Values` array accepts numbers of type `Double`, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, \$1Infinity, -Infinity) are not supported.  
Type: Array of doubles  
Required: No

## See Also
<a name="API_MetricDatum_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MetricDatum) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MetricDatum) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MetricDatum) 

# MetricMathAnomalyDetector
<a name="API_MetricMathAnomalyDetector"></a>

Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input. The designated math expression must return a single time series.

## Contents
<a name="API_MetricMathAnomalyDetector_Contents"></a>

 ** MetricDataQueries **   <a name="ACW-Type-MetricMathAnomalyDetector-MetricDataQueries"></a>
An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression. Each item in `MetricDataQueries` gets a metric or performs a math expression. One item in `MetricDataQueries` is the expression that provides the time series that the anomaly detector uses as input. Designate the expression by setting `ReturnData` to `true` for this object in the array. For all other expressions and metrics, set `ReturnData` to `false`. The designated expression must return a single time series.  
Type: Array of [MetricDataQuery](API_MetricDataQuery.md) objects  
Required: No

## See Also
<a name="API_MetricMathAnomalyDetector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MetricMathAnomalyDetector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MetricMathAnomalyDetector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MetricMathAnomalyDetector) 

# MetricStat
<a name="API_MetricStat"></a>

This structure defines the metric to be returned, along with the statistics, period, and units.

## Contents
<a name="API_MetricStat_Contents"></a>

 ** Metric **   <a name="ACW-Type-MetricStat-Metric"></a>
The metric to return, including the metric name, namespace, and dimensions.  
Type: [Metric](API_Metric.md) object  
Required: Yes

 ** Period **   <a name="ACW-Type-MetricStat-Period"></a>
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a `PutMetricData` call that includes a `StorageResolution` of 1 second.  
If the `StartTime` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:  
+ Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
+ Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
+ Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
Type: Integer  
Valid Range: Minimum value of 1.  
Required: Yes

 ** Stat **   <a name="ACW-Type-MetricStat-Stat"></a>
The statistic to return. It can include any CloudWatch statistic or extended statistic.  
Type: String  
Required: Yes

 ** Unit **   <a name="ACW-Type-MetricStat-Unit"></a>
When you are using a `Put` operation, this defines what unit you want to use when storing the metric.  
In a `Get` operation, if you omit `Unit` then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.  
Type: String  
Valid Values: `Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None`   
Required: No

## See Also
<a name="API_MetricStat_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MetricStat) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MetricStat) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MetricStat) 

# MetricStreamEntry
<a name="API_MetricStreamEntry"></a>

This structure contains the configuration information about one metric stream.

## Contents
<a name="API_MetricStreamEntry_Contents"></a>

 ** Arn **   <a name="ACW-Type-MetricStreamEntry-Arn"></a>
The ARN of the metric stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** CreationDate **   <a name="ACW-Type-MetricStreamEntry-CreationDate"></a>
The date that the metric stream was originally created.  
Type: Timestamp  
Required: No

 ** FirehoseArn **   <a name="ACW-Type-MetricStreamEntry-FirehoseArn"></a>
The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** LastUpdateDate **   <a name="ACW-Type-MetricStreamEntry-LastUpdateDate"></a>
The date that the configuration of this metric stream was most recently updated.  
Type: Timestamp  
Required: No

 ** Name **   <a name="ACW-Type-MetricStreamEntry-Name"></a>
The name of the metric stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** OutputFormat **   <a name="ACW-Type-MetricStreamEntry-OutputFormat"></a>
The output format of this metric stream. Valid values are `json`, `opentelemetry1.0`, and `opentelemetry0.7`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Valid Values: `json | opentelemetry0.7 | opentelemetry1.0`   
Required: No

 ** State **   <a name="ACW-Type-MetricStreamEntry-State"></a>
The current state of this stream. Valid values are `running` and `stopped`.  
Type: String  
Required: No

## See Also
<a name="API_MetricStreamEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MetricStreamEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MetricStreamEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MetricStreamEntry) 

# MetricStreamFilter
<a name="API_MetricStreamFilter"></a>

This structure contains a metric namespace and optionally, a list of metric names, to either include in a metric stream or exclude from a metric stream.

A metric stream's filters can include up to 1000 total names. This limit applies to the sum of namespace names and metric names in the filters. For example, this could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with 49 metrics specified in each filter.

## Contents
<a name="API_MetricStreamFilter_Contents"></a>

 ** MetricNames **   <a name="ACW-Type-MetricStreamFilter-MetricNames"></a>
The names of the metrics to either include or exclude from the metric stream.   
If you omit this parameter, all metrics in the namespace are included or excluded, depending on whether this filter is specified as an exclude filter or an include filter.  
Each metric name can contain only ASCII printable characters (ASCII range 32 through 126). Each metric name must contain at least one non-whitespace character.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** Namespace **   <a name="ACW-Type-MetricStreamFilter-Namespace"></a>
The name of the metric namespace for this filter.  
The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must contain at least one non-whitespace character.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[^:].*`   
Required: No

## See Also
<a name="API_MetricStreamFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MetricStreamFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MetricStreamFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MetricStreamFilter) 

# MetricStreamStatisticsConfiguration
<a name="API_MetricStreamStatisticsConfiguration"></a>

By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and `SAMPLECOUNT` statistics for each metric that is streamed. This structure contains information for one metric that includes additional statistics in the stream. For more information about statistics, see CloudWatch, listed in [ CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html).

## Contents
<a name="API_MetricStreamStatisticsConfiguration_Contents"></a>

 ** AdditionalStatistics **   <a name="ACW-Type-MetricStreamStatisticsConfiguration-AdditionalStatistics"></a>
The list of additional statistics that are to be streamed for the metrics listed in the `IncludeMetrics` array in this structure. This list can include as many as 20 statistics.  
If the `OutputFormat` for the stream is `opentelemetry1.0` or `opentelemetry0.7`, the only valid values are `p?? ` percentile statistics such as `p90`, `p99` and so on.  
If the `OutputFormat` for the stream is `json`, the valid values include the abbreviations for all of the statistics listed in [ CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html). For example, this includes `tm98, ` `wm90`, `PR(:300)`, and so on.  
Type: Array of strings  
Required: Yes

 ** IncludeMetrics **   <a name="ACW-Type-MetricStreamStatisticsConfiguration-IncludeMetrics"></a>
An array of metric name and namespace pairs that stream the additional statistics listed in the value of the `AdditionalStatistics` parameter. There can be as many as 100 pairs in the array.  
All metrics that match the combination of metric name and namespace will be streamed with the additional statistics, no matter their dimensions.  
Type: Array of [MetricStreamStatisticsMetric](API_MetricStreamStatisticsMetric.md) objects  
Required: Yes

## See Also
<a name="API_MetricStreamStatisticsConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MetricStreamStatisticsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MetricStreamStatisticsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MetricStreamStatisticsConfiguration) 

# MetricStreamStatisticsMetric
<a name="API_MetricStreamStatisticsMetric"></a>

This object contains the information for one metric that is to be streamed with additional statistics.

## Contents
<a name="API_MetricStreamStatisticsMetric_Contents"></a>

 ** MetricName **   <a name="ACW-Type-MetricStreamStatisticsMetric-MetricName"></a>
The name of the metric.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** Namespace **   <a name="ACW-Type-MetricStreamStatisticsMetric-Namespace"></a>
The namespace of the metric.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[^:].*`   
Required: Yes

## See Also
<a name="API_MetricStreamStatisticsMetric_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MetricStreamStatisticsMetric) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MetricStreamStatisticsMetric) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MetricStreamStatisticsMetric) 

# MuteTargets
<a name="API_MuteTargets"></a>

Specifies which alarms an alarm mute rule applies to.

You can target up to 100 specific alarms by name. When a mute rule is active, the targeted alarms continue to evaluate metrics and transition between states, but their configured actions are muted.

## Contents
<a name="API_MuteTargets_Contents"></a>

 ** AlarmNames **   <a name="ACW-Type-MuteTargets-AlarmNames"></a>
The list of alarm names that this mute rule targets. You can specify up to 100 alarm names.  
Each alarm name must be between 1 and 255 characters in length. The alarm names must match existing alarms in your AWS account and region.  
Type: Array of strings  
Array Members: Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## See Also
<a name="API_MuteTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/MuteTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/MuteTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/MuteTargets) 

# PartialFailure
<a name="API_PartialFailure"></a>

This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.

## Contents
<a name="API_PartialFailure_Contents"></a>

 ** ExceptionType **   <a name="ACW-Type-PartialFailure-ExceptionType"></a>
The type of error.  
Type: String  
Required: No

 ** FailureCode **   <a name="ACW-Type-PartialFailure-FailureCode"></a>
The code of the error.  
Type: String  
Required: No

 ** FailureDescription **   <a name="ACW-Type-PartialFailure-FailureDescription"></a>
A description of the error.  
Type: String  
Required: No

 ** FailureResource **   <a name="ACW-Type-PartialFailure-FailureResource"></a>
The specified rule that could not be deleted.  
Type: String  
Required: No

## See Also
<a name="API_PartialFailure_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/PartialFailure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/PartialFailure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/PartialFailure) 

# Range
<a name="API_Range"></a>

Specifies one range of days or times to exclude from use for training an anomaly detection model.

## Contents
<a name="API_Range_Contents"></a>

 ** EndTime **   <a name="ACW-Type-Range-EndTime"></a>
The end time of the range to exclude. The format is `yyyy-MM-dd'T'HH:mm:ss`. For example, `2019-07-01T23:59:59`.  
Type: Timestamp  
Required: Yes

 ** StartTime **   <a name="ACW-Type-Range-StartTime"></a>
The start time of the range to exclude. The format is `yyyy-MM-dd'T'HH:mm:ss`. For example, `2019-07-01T23:59:59`.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_Range_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/Range) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/Range) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/Range) 

# Rule
<a name="API_Rule"></a>

Defines the schedule configuration for an alarm mute rule.

The rule contains a schedule that specifies when and how long alarms should be muted. The schedule can be a recurring pattern using cron expressions or a one-time mute window using at expressions.

## Contents
<a name="API_Rule_Contents"></a>

 ** Schedule **   <a name="ACW-Type-Rule-Schedule"></a>
The schedule configuration that defines when the mute rule activates and how long it remains active.  
Type: [Schedule](API_Schedule.md) object  
Required: Yes

## See Also
<a name="API_Rule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/Rule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/Rule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/Rule) 

# Schedule
<a name="API_Schedule"></a>

Specifies when and how long an alarm mute rule is active.

The schedule uses either a cron expression for recurring mute windows or an at expression for one-time mute windows. When the schedule activates, the mute rule mutes alarm actions for the specified duration.

## Contents
<a name="API_Schedule_Contents"></a>

 ** Duration **   <a name="ACW-Type-Schedule-Duration"></a>
The length of time that alarms remain muted when the schedule activates. The duration must be between 1 and 50 characters in length.  
Specify the duration using ISO 8601 duration format with a minimum of 1 minute (`PT1M`) and maximum of 15 days (`P15D`).  
Examples:  
+  `PT4H` - 4 hours for weekly system maintenance
+  `P2DT12H` - 2 days and 12 hours for weekend muting from Friday 6:00 PM to Monday 6:00 AM
+  `PT6H` - 6 hours for monthly database maintenance
+  `PT2H` - 2 hours for nightly backup operations
+  `P7D` - 7 days for annual company shutdown
The duration begins when the schedule expression time is reached. For recurring schedules, the duration applies to each occurrence.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: Yes

 ** Expression **   <a name="ACW-Type-Schedule-Expression"></a>
The schedule expression that defines when the mute rule activates. The expression must be between 1 and 256 characters in length.  
You can use one of two expression formats:  
+  **Cron expressions** - For recurring mute windows. Format: `cron(Minutes Hours Day-of-month Month Day-of-week)` 

  Examples:
  +  `cron(0 2 * * *)` - Activates daily at 2:00 AM
  +  `cron(0 2 * * SUN)` - Activates every Sunday at 2:00 AM for weekly system maintenance
  +  `cron(0 1 1 * *)` - Activates on the first day of each month at 1:00 AM for monthly database maintenance
  +  `cron(0 18 * * FRI)` - Activates every Friday at 6:00 PM
  +  `cron(0 23 * * *)` - Activates every day at 11:00 PM during nightly backup operations

  The characters `*`, `-`, and `,` are supported in all fields. English names can be used for the month (JAN-DEC) and day of week (SUN-SAT) fields.
+  **At expressions** - For one-time mute windows. Format: `at(yyyy-MM-ddThh:mm)` 

  Examples:
  +  `at(2024-05-10T14:00)` - Activates once on May 10, 2024 at 2:00 PM during an active incident response session
  +  `at(2024-12-23T00:00)` - Activates once on December 23, 2024 at midnight during annual company shutdown
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** Timezone **   <a name="ACW-Type-Schedule-Timezone"></a>
The time zone to use when evaluating the schedule expression. The time zone must be between 1 and 50 characters in length.  
Specify the time zone using standard timezone identifiers (for example, `America/New_York`, `Europe/London`, or `Asia/Tokyo`).  
If you don't specify a time zone, UTC is used by default. The time zone affects how cron and at expressions are interpreted, as well as start and expire dates you specify  
Examples:  
+  `America/New_York` - Eastern Time (US)
+  `America/Los_Angeles` - Pacific Time (US)
+  `Europe/London` - British Time
+  `Asia/Tokyo` - Japan Standard Time
+  `UTC` - Coordinated Universal Time
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

## See Also
<a name="API_Schedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/Schedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/Schedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/Schedule) 

# SingleMetricAnomalyDetector
<a name="API_SingleMetricAnomalyDetector"></a>

Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input. 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.

## Contents
<a name="API_SingleMetricAnomalyDetector_Contents"></a>

 ** AccountId **   <a name="ACW-Type-SingleMetricAnomalyDetector-AccountId"></a>
If the CloudWatch metric that provides the time series that the anomaly detector uses as input is in another account, specify that account ID here. If you omit this parameter, the current account is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** Dimensions **   <a name="ACW-Type-SingleMetricAnomalyDetector-Dimensions"></a>
The metric dimensions to create the anomaly detection model for.  
Type: Array of [Dimension](API_Dimension.md) objects  
Array Members: Maximum number of 30 items.  
Required: No

 ** MetricName **   <a name="ACW-Type-SingleMetricAnomalyDetector-MetricName"></a>
The name of the metric to create the anomaly detection model for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** Namespace **   <a name="ACW-Type-SingleMetricAnomalyDetector-Namespace"></a>
The namespace of the metric to create the anomaly detection model for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[^:].*`   
Required: No

 ** Stat **   <a name="ACW-Type-SingleMetricAnomalyDetector-Stat"></a>
The statistic to use for the metric and anomaly detection model.  
Type: String  
Length Constraints: Maximum length of 50.  
Pattern: `(SampleCount|Average|Sum|Minimum|Maximum|IQM|(p|tc|tm|ts|wm)(\d{1,2}(\.\d{0,10})?|100)|[ou]\d+(\.\d*)?)(_E|_L|_H)?|(TM|TC|TS|WM)\(((((\d{1,2})(\.\d{0,10})?|100(\.0{0,10})?)%)?:((\d{1,2})(\.\d{0,10})?|100(\.0{0,10})?)%|((\d{1,2})(\.\d{0,10})?|100(\.0{0,10})?)%:(((\d{1,2})(\.\d{0,10})?|100(\.0{0,10})?)%)?)\)|(TM|TC|TS|WM|PR)\(((\d+(\.\d{0,10})?|(\d+(\.\d{0,10})?[Ee][+-]?\d+)):((\d+(\.\d{0,10})?|(\d+(\.\d{0,10})?[Ee][+-]?\d+)))?|((\d+(\.\d{0,10})?|(\d+(\.\d{0,10})?[Ee][+-]?\d+)))?:(\d+(\.\d{0,10})?|(\d+(\.\d{0,10})?[Ee][+-]?\d+)))\)`   
Required: No

## See Also
<a name="API_SingleMetricAnomalyDetector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/SingleMetricAnomalyDetector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/SingleMetricAnomalyDetector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/SingleMetricAnomalyDetector) 

# StatisticSet
<a name="API_StatisticSet"></a>

Represents a set of statistics that describes a specific metric. 

## Contents
<a name="API_StatisticSet_Contents"></a>

 ** Maximum **   <a name="ACW-Type-StatisticSet-Maximum"></a>
The maximum value of the sample set.  
Type: Double  
Required: Yes

 ** Minimum **   <a name="ACW-Type-StatisticSet-Minimum"></a>
The minimum value of the sample set.  
Type: Double  
Required: Yes

 ** SampleCount **   <a name="ACW-Type-StatisticSet-SampleCount"></a>
The number of samples used for the statistic set.  
Type: Double  
Required: Yes

 ** Sum **   <a name="ACW-Type-StatisticSet-Sum"></a>
The sum of values for the sample set.  
Type: Double  
Required: Yes

## See Also
<a name="API_StatisticSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/StatisticSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/StatisticSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/StatisticSet) 

# Tag
<a name="API_Tag"></a>

A key-value pair associated with a CloudWatch resource.

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="ACW-Type-Tag-Key"></a>
A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** Value **   <a name="ACW-Type-Tag-Value"></a>
The value for the specified tag key.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/Tag)