DescribeAlarmHistory
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 all alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AlarmName
-
The name of the alarm.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- EndDate
-
The ending date to retrieve alarm history.
Type: Timestamp
Required: No
- HistoryItemType
-
The type of alarm histories to retrieve.
Type: String
Valid Values:
ConfigurationUpdate | StateUpdate | ActionRequired: No
- MaxRecords
-
The maximum number of alarm history records to retrieve.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token returned by a previous call to indicate that there is more data available.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- StartDate
-
The starting date to retrieve alarm history.
Type: Timestamp
Required: No
Response Elements
The following elements are returned by the service.
- AlarmHistoryItems.member.N
-
The alarm histories, in JSON format.
Type: Array of AlarmHistoryItem objects
- NextToken
-
The token that marks the start of the next batch of returned results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextToken
-
The next token specified is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
