alarm_histories
Creates, updates, deletes, gets or lists an alarm_histories resource.
Overview
| Name | alarm_histories |
| Type | Resource |
| Id | aws.cloudwatch.alarm_histories |
Fields
The following fields are returned by SELECT queries:
- describe_alarm_history
| Name | Datatype | Description |
|---|---|---|
alarm_contributor_attributes | object | 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. |
alarm_contributor_id | string | The unique identifier of the alarm contributor associated with this history item, if applicable. |
alarm_name | string | The descriptive name for the alarm. |
alarm_type | string | The type of alarm, either metric alarm or composite alarm. (CompositeAlarm, MetricAlarm, LogAlarm) |
history_data | string | Data about the alarm, in JSON format. |
history_item_type | string | The type of alarm history item. (ConfigurationUpdate, StateUpdate, Action, AlarmContributorStateUpdate, AlarmContributorAction) |
history_summary | string | A summary of the alarm history, in text format. |
timestamp | string (date-time) | The time stamp for the alarm history item. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_alarm_history | select | region | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_alarm_history
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.
SELECT
alarm_contributor_attributes,
alarm_contributor_id,
alarm_name,
alarm_type,
history_data,
history_item_type,
history_summary,
timestamp
FROM aws.cloudwatch.alarm_histories
WHERE region = '{{ region }}' -- required
;