class Aws::CloudWatch::Types::DescribeAlarmsInput

@note When making an API call, you may pass DescribeAlarmsInput

data as a hash:

    {
      alarm_names: ["AlarmName"],
      alarm_name_prefix: "AlarmNamePrefix",
      alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
      children_of_alarm_name: "AlarmName",
      parents_of_alarm_name: "AlarmName",
      state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA
      action_prefix: "ActionPrefix",
      max_records: 1,
      next_token: "NextToken",
    }

@!attribute [rw] alarm_names

The names of the alarms to retrieve information about.
@return [Array<String>]

@!attribute [rw] alarm_name_prefix

An alarm name prefix. If you specify this parameter, you receive
information about all alarms that have names that start with this
prefix.

If this parameter is specified, you cannot specify `AlarmNames`.
@return [String]

@!attribute [rw] alarm_types

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.
@return [Array<String>]

@!attribute [rw] children_of_alarm_name

If you use this parameter and specify the name of a composite alarm,
the operation returns information about the "children" alarms of
the alarm you specify. These are the metric alarms and composite
alarms referenced in the `AlarmRule` field of the composite alarm
that you specify in `ChildrenOfAlarmName`. Information about the
composite alarm that you name in `ChildrenOfAlarmName` is not
returned.

If you specify `ChildrenOfAlarmName`, you cannot specify any other
parameters in the request except for `MaxRecords` and `NextToken`.
If you do so, you receive a validation error.

<note markdown="1"> Only the `Alarm Name`, `ARN`, `StateValue`
(OK/ALARM/INSUFFICIENT\_DATA), and `StateUpdatedTimestamp`
information are returned by this operation when you use this
parameter. To get complete information about these alarms, perform
another `DescribeAlarms` operation and specify the parent alarm
names in the `AlarmNames` parameter.

 </note>
@return [String]

@!attribute [rw] parents_of_alarm_name

If you use this parameter and specify the name of a metric or
composite alarm, the operation returns information about the
"parent" alarms of the alarm you specify. These are the composite
alarms that have `AlarmRule` parameters that reference the alarm
named in `ParentsOfAlarmName`. Information about the alarm that you
specify in `ParentsOfAlarmName` is not returned.

If you specify `ParentsOfAlarmName`, you cannot specify any other
parameters in the request except for `MaxRecords` and `NextToken`.
If you do so, you receive a validation error.

<note markdown="1"> Only the Alarm Name and ARN are returned by this operation when you
use this parameter. To get complete information about these alarms,
perform another `DescribeAlarms` operation and specify the parent
alarm names in the `AlarmNames` parameter.

 </note>
@return [String]

@!attribute [rw] state_value

Specify this parameter to receive information only about alarms that
are currently in the state that you specify.
@return [String]

@!attribute [rw] action_prefix

Use this parameter to filter the results of the operation to only
those alarms that use a certain alarm action. For example, you could
specify the ARN of an SNS topic to find all alarms that send
notifications to that topic.
@return [String]

@!attribute [rw] max_records

The maximum number of alarm descriptions to retrieve.
@return [Integer]

@!attribute [rw] next_token

The token returned by a previous call to indicate that there is more
data available.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsInput AWS API Documentation

Constants

SENSITIVE