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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeAlarmsInput as input to an Aws::Client method, you can use a vanilla 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)

    The action name prefix.

#alarm_name_prefixString

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

Returns:

  • (String)

    The alarm name prefix.

#alarm_namesArray<String>

The names of the alarms.

Returns:

  • (Array<String>)

    The names of the alarms.

#max_recordsInteger

The maximum number of alarm descriptions to retrieve.

Returns:

  • (Integer)

    The maximum number of alarm descriptions to retrieve.

#next_tokenString

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

Returns:

  • (String)

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

#state_valueString

The state value to be used in matching alarms.

Possible values:

  • OK
  • ALARM
  • INSUFFICIENT_DATA

Returns:

  • (String)

    The state value to be used in matching alarms.