v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1476259373.1 KB

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

get/#Action=DescribeAlarmHistory

Query parameters

AlarmNamestring

The name of the alarm.

AlarmTypesAlarmType[]

Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.

HistoryItemType'ConfigurationUpdate' | 'StateUpdate' | 'Action'

The type of alarm histories to retrieve.

StartDatestring date-time

The starting date to retrieve alarm history.

EndDatestring date-time

The ending date to retrieve alarm history.

MaxRecordsinteger

The maximum number of alarm history records to retrieve.

NextTokenstring

The token returned by a previous call to indicate that there is more data available.

ScanBy'TimestampDescending' | 'TimestampAscending'

Specified whether to return the newest or oldest alarm history first. Specify <code>TimestampDescending</code> to have the newest event history returned first, and specify <code>TimestampAscending</code> to have the oldest history returned first.

Action'DescribeAlarmHistory' required
Version'2010-08-01' required

Response

Success