MetricAlarm
The details about a metric alarm.
Types
Properties
Indicates whether actions should be executed during any changes to the alarm state.
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).
The time stamp of the last update to the alarm configuration.
The description of the alarm.
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
The number of data points that must be breaching to trigger the alarm.
The dimensions for the metric associated with the alarm.
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.
The number of periods over which data is compared to the specified threshold.
If the value of this field is PARTIAL_DATA, the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics. For more information, see Create alarms on Metrics Insights queries.
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
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).
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
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.
An explanation for the alarm state, in text format.
An explanation for the alarm state, in JSON format.
The date and time that the alarm's StateValue most recently changed.
The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.
The state value for the alarm.
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.
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.
The unit of the metric associated with the alarm.