/ 
Paws-0.43
⭐ Starred 171 / 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
  MaxRecords => 1,                # OPTIONAL
  NextToken  => 'MyNextToken',    # OPTIONAL
  StateValue => 'OK',             # OPTIONAL
);

# Results:
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

The action name prefix.

AlarmNamePrefix => Str

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

AlarmNames => ArrayRef[Str|Undef]

The names of the alarms.

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.

StateValue => Str

The state value to be used in matching alarms.

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