You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudWatch::Types::DescribeAlarmsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatch/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

Instance Attribute Details

#action_prefixString

The action name prefix.

Returns:

  • (String)


362
363
364
365
366
367
368
369
370
# File 'gems/aws-sdk-cloudwatch/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_prefixString

The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.

Returns:

  • (String)


362
363
364
365
366
367
368
369
370
# File 'gems/aws-sdk-cloudwatch/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_namesArray<String>

The names of the alarms.

Returns:

  • (Array<String>)


362
363
364
365
366
367
368
369
370
# File 'gems/aws-sdk-cloudwatch/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_recordsInteger

The maximum number of alarm descriptions to retrieve.

Returns:

  • (Integer)


362
363
364
365
366
367
368
369
370
# File 'gems/aws-sdk-cloudwatch/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_tokenString

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

Returns:

  • (String)


362
363
364
365
366
367
368
369
370
# File 'gems/aws-sdk-cloudwatch/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_valueString

The state value to be used in matching alarms.

Returns:

  • (String)


362
363
364
365
366
367
368
369
370
# File 'gems/aws-sdk-cloudwatch/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