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

Inherits:
Struct
  • Object
show all
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",
  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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_prefixString

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.

Returns:

  • (String)

772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/aws-sdk-cloudwatch/types.rb', line 772

class DescribeAlarmsInput < Struct.new(
  :alarm_names,
  :alarm_name_prefix,
  :alarm_types,
  :children_of_alarm_name,
  :parents_of_alarm_name,
  :state_value,
  :action_prefix,
  :max_records,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_name_prefixString

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`.

Returns:

  • (String)

772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/aws-sdk-cloudwatch/types.rb', line 772

class DescribeAlarmsInput < Struct.new(
  :alarm_names,
  :alarm_name_prefix,
  :alarm_types,
  :children_of_alarm_name,
  :parents_of_alarm_name,
  :state_value,
  :action_prefix,
  :max_records,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_namesArray<String>

The names of the alarms to retrieve information about.

Returns:

  • (Array<String>)

772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/aws-sdk-cloudwatch/types.rb', line 772

class DescribeAlarmsInput < Struct.new(
  :alarm_names,
  :alarm_name_prefix,
  :alarm_types,
  :children_of_alarm_name,
  :parents_of_alarm_name,
  :state_value,
  :action_prefix,
  :max_records,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_typesArray<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.

Returns:

  • (Array<String>)

772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/aws-sdk-cloudwatch/types.rb', line 772

class DescribeAlarmsInput < Struct.new(
  :alarm_names,
  :alarm_name_prefix,
  :alarm_types,
  :children_of_alarm_name,
  :parents_of_alarm_name,
  :state_value,
  :action_prefix,
  :max_records,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#children_of_alarm_nameString

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>

Returns:

  • (String)

772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/aws-sdk-cloudwatch/types.rb', line 772

class DescribeAlarmsInput < Struct.new(
  :alarm_names,
  :alarm_name_prefix,
  :alarm_types,
  :children_of_alarm_name,
  :parents_of_alarm_name,
  :state_value,
  :action_prefix,
  :max_records,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_recordsInteger

The maximum number of alarm descriptions to retrieve.

Returns:

  • (Integer)

772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/aws-sdk-cloudwatch/types.rb', line 772

class DescribeAlarmsInput < Struct.new(
  :alarm_names,
  :alarm_name_prefix,
  :alarm_types,
  :children_of_alarm_name,
  :parents_of_alarm_name,
  :state_value,
  :action_prefix,
  :max_records,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)

772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/aws-sdk-cloudwatch/types.rb', line 772

class DescribeAlarmsInput < Struct.new(
  :alarm_names,
  :alarm_name_prefix,
  :alarm_types,
  :children_of_alarm_name,
  :parents_of_alarm_name,
  :state_value,
  :action_prefix,
  :max_records,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#parents_of_alarm_nameString

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>

Returns:

  • (String)

772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/aws-sdk-cloudwatch/types.rb', line 772

class DescribeAlarmsInput < Struct.new(
  :alarm_names,
  :alarm_name_prefix,
  :alarm_types,
  :children_of_alarm_name,
  :parents_of_alarm_name,
  :state_value,
  :action_prefix,
  :max_records,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#state_valueString

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

Returns:

  • (String)

772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/aws-sdk-cloudwatch/types.rb', line 772

class DescribeAlarmsInput < Struct.new(
  :alarm_names,
  :alarm_name_prefix,
  :alarm_types,
  :children_of_alarm_name,
  :parents_of_alarm_name,
  :state_value,
  :action_prefix,
  :max_records,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end