/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CloudWatch::DescribeAlarms

NAME

Paws::CloudWatch::DescribeAlarms - Arguments for method DescribeAlarms on Paws::CloudWatch

DESCRIPTION

This class represents the parameters used for calling the method DescribeAlarms on the Amazon CloudWatch service. Use the attributes of this class as arguments to method DescribeAlarms.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeAlarms.

SYNOPSIS

my $monitoring = Paws->service('CloudWatch');
my $DescribeAlarmsOutput = $monitoring->DescribeAlarms(
  ActionPrefix    => 'MyActionPrefix',       # OPTIONAL
  AlarmNamePrefix => 'MyAlarmNamePrefix',    # OPTIONAL
  AlarmNames      => [
    'MyAlarmName', ...                       # min: 1, max: 255
  ],    # OPTIONAL
  AlarmTypes => [
    'CompositeAlarm', ...    # values: CompositeAlarm, MetricAlarm
  ],    # OPTIONAL
  ChildrenOfAlarmName => 'MyAlarmName',    # OPTIONAL
  MaxRecords          => 1,                # OPTIONAL
  NextToken           => 'MyNextToken',    # OPTIONAL
  ParentsOfAlarmName  => 'MyAlarmName',    # OPTIONAL
  StateValue          => 'OK',             # OPTIONAL
);

# Results:
my $CompositeAlarms = $DescribeAlarmsOutput->CompositeAlarms;
my $MetricAlarms    = $DescribeAlarmsOutput->MetricAlarms;
my $NextToken       = $DescribeAlarmsOutput->NextToken;

# Returns a L<Paws::CloudWatch::DescribeAlarmsOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/monitoring/DescribeAlarms

ATTRIBUTES

ActionPrefix => Str

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.

AlarmNamePrefix => Str

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.

AlarmNames => ArrayRef[Str|Undef]

The names of the alarms to retrieve information about.

AlarmTypes => ArrayRef[Str|Undef]

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.

ChildrenOfAlarmName => Str

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.

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.

MaxRecords => Int

The maximum number of alarm descriptions to retrieve.

NextToken => Str

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

ParentsOfAlarmName => Str

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.

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.

StateValue => Str

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

Valid values are: "OK", "ALARM", "INSUFFICIENT_DATA"

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeAlarms in Paws::CloudWatch

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues