AWS CloudWatch · Schema
MetricAlarm
The details about a metric alarm.
AlarmsAwsDashboardsLogsMetricsMonitoringObservability
Properties
| Name | Type | Description |
|---|---|---|
| AlarmName | string | The name of the alarm. |
| AlarmArn | string | The Amazon Resource Name (ARN) of the alarm. |
| AlarmDescription | string | The description of the alarm. |
| AlarmConfigurationUpdatedTimestamp | string | The time stamp of the last update to the alarm configuration. |
| ActionsEnabled | boolean | Indicates whether actions should be executed during any changes to the alarm state. |
| OKActions | array | The actions to execute when this alarm transitions to the OK state. |
| AlarmActions | array | The actions to execute when this alarm transitions to the ALARM state. |
| InsufficientDataActions | array | The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state. |
| StateReason | string | An explanation for the alarm state, in text format. |
| StateReasonData | string | An explanation for the alarm state, in JSON format. |
| StateUpdatedTimestamp | string | The time stamp of the last update to the value of either the StateValue or StateReasonData. |
| MetricName | string | The name of the metric associated with the alarm. |
| Namespace | string | The namespace of the metric associated with the alarm. |
| ExtendedStatistic | string | The percentile statistic for the metric associated with the alarm. |
| Dimensions | array | The dimensions for the metric associated with the alarm. |
| Period | integer | The period, in seconds, over which the statistic is applied. |
| EvaluationPeriods | integer | The number of periods over which data is compared to the specified threshold. |
| DatapointsToAlarm | integer | The number of data points that must be breaching to trigger the alarm. |
| Threshold | number | The value to compare with the specified statistic. |
| TreatMissingData | string | Sets how this alarm is to handle missing data points. |
| EvaluateLowSampleCountPercentile | string | Used only for alarms based on percentiles. |
| Metrics | array | An array of MetricDataQuery structures for metric math expressions. |
| ThresholdMetricId | string | If the value of this field is set to an alarm metric ID, the alarm is based on an anomaly detection model. |
| StateTransitionedTimestamp | string | The date and time that the alarm's StateValue most recently changed. |