Class: Aws::CloudWatch::Types::DescribeAlarmsInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudWatch::Types::DescribeAlarmsInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cloudwatch/types.rb
Overview
Note:
When making an API call, you may pass DescribeAlarmsInput data as a hash:
{
alarm_names: ["AlarmName"],
alarm_name_prefix: "AlarmNamePrefix",
state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA
action_prefix: "ActionPrefix",
max_records: 1,
next_token: "NextToken",
}
Instance Attribute Summary collapse
-
#action_prefix ⇒ String
The action name prefix.
-
#alarm_name_prefix ⇒ String
The alarm name prefix.
-
#alarm_names ⇒ Array<String>
The names of the alarms.
-
#max_records ⇒ Integer
The maximum number of alarm descriptions to retrieve.
-
#next_token ⇒ String
The token returned by a previous call to indicate that there is more data available.
-
#state_value ⇒ String
The state value to be used in matching alarms.
Instance Attribute Details
#action_prefix ⇒ String
The action name prefix.
362 363 364 365 366 367 368 369 370 |
# File 'lib/aws-sdk-cloudwatch/types.rb', line 362 class DescribeAlarmsInput < Struct.new( :alarm_names, :alarm_name_prefix, :state_value, :action_prefix, :max_records, :next_token) include Aws::Structure end |
#alarm_name_prefix ⇒ String
The alarm name prefix. If this parameter is specified, you cannot specify ‘AlarmNames`.
362 363 364 365 366 367 368 369 370 |
# File 'lib/aws-sdk-cloudwatch/types.rb', line 362 class DescribeAlarmsInput < Struct.new( :alarm_names, :alarm_name_prefix, :state_value, :action_prefix, :max_records, :next_token) include Aws::Structure end |
#alarm_names ⇒ Array<String>
The names of the alarms.
362 363 364 365 366 367 368 369 370 |
# File 'lib/aws-sdk-cloudwatch/types.rb', line 362 class DescribeAlarmsInput < Struct.new( :alarm_names, :alarm_name_prefix, :state_value, :action_prefix, :max_records, :next_token) include Aws::Structure end |
#max_records ⇒ Integer
The maximum number of alarm descriptions to retrieve.
362 363 364 365 366 367 368 369 370 |
# File 'lib/aws-sdk-cloudwatch/types.rb', line 362 class DescribeAlarmsInput < Struct.new( :alarm_names, :alarm_name_prefix, :state_value, :action_prefix, :max_records, :next_token) include Aws::Structure end |
#next_token ⇒ String
The token returned by a previous call to indicate that there is more data available.
362 363 364 365 366 367 368 369 370 |
# File 'lib/aws-sdk-cloudwatch/types.rb', line 362 class DescribeAlarmsInput < Struct.new( :alarm_names, :alarm_name_prefix, :state_value, :action_prefix, :max_records, :next_token) include Aws::Structure end |
#state_value ⇒ String
The state value to be used in matching alarms.
362 363 364 365 366 367 368 369 370 |
# File 'lib/aws-sdk-cloudwatch/types.rb', line 362 class DescribeAlarmsInput < Struct.new( :alarm_names, :alarm_name_prefix, :state_value, :action_prefix, :max_records, :next_token) include Aws::Structure end |