You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudWatch::Types::DescribeAlarmHistoryInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudWatch::Types::DescribeAlarmHistoryInput
- Defined in:
- (unknown)
Overview
When passing DescribeAlarmHistoryInput as input to an Aws::Client method, you can use a vanilla Hash:
{
alarm_name: "AlarmName",
alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action
start_date: Time.now,
end_date: Time.now,
max_records: 1,
next_token: "NextToken",
scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending
}
Instance Attribute Summary collapse
-
#alarm_name ⇒ String
The name of the alarm.
-
#alarm_types ⇒ Array<String>
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
-
#end_date ⇒ Time
The ending date to retrieve alarm history.
-
#history_item_type ⇒ String
The type of alarm histories to retrieve.
-
#max_records ⇒ Integer
The maximum number of alarm history records to retrieve.
-
#next_token ⇒ String
The token returned by a previous call to indicate that there is more data available.
-
#scan_by ⇒ String
Specified whether to return the newest or oldest alarm history first.
-
#start_date ⇒ Time
The starting date to retrieve alarm history.
Instance Attribute Details
#alarm_name ⇒ String
The name of the alarm.
#alarm_types ⇒ Array<String>
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.
#end_date ⇒ Time
The ending date to retrieve alarm history.
#history_item_type ⇒ String
The type of alarm histories to retrieve.
Possible values:
- ConfigurationUpdate
- StateUpdate
- Action
#max_records ⇒ Integer
The maximum number of alarm history records to retrieve.
#next_token ⇒ String
The token returned by a previous call to indicate that there is more data available.
#scan_by ⇒ String
Specified whether to return the newest or oldest alarm history first.
Specify TimestampDescending
to have the newest event history returned
first, and specify TimestampAscending
to have the oldest history
returned first.
Possible values:
- TimestampDescending
- TimestampAscending
#start_date ⇒ Time
The starting date to retrieve alarm history.