NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $monitoring = Paws->service('CloudWatch');
    my $DescribeAlarmHistoryOutput = $monitoring->DescribeAlarmHistory(
      AlarmName  => 'MyAlarmName',    # OPTIONAL
      AlarmTypes => [
        'CompositeAlarm', ...         # values: CompositeAlarm, MetricAlarm
      ],    # OPTIONAL
      EndDate         => '1970-01-01T01:00:00',    # OPTIONAL
      HistoryItemType => 'ConfigurationUpdate',    # OPTIONAL
      MaxRecords      => 1,                        # OPTIONAL
      NextToken       => 'MyNextToken',            # OPTIONAL
      ScanBy          => 'TimestampDescending',    # OPTIONAL
      StartDate       => '1970-01-01T01:00:00',    # OPTIONAL
    );

    # Results:
    my $AlarmHistoryItems = $DescribeAlarmHistoryOutput->AlarmHistoryItems;
    my $NextToken         = $DescribeAlarmHistoryOutput->NextToken;

    # Returns a L<Paws::CloudWatch::DescribeAlarmHistoryOutput> 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/DescribeAlarmHistory

ATTRIBUTES

AlarmName => Str

The name of the alarm.

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.

EndDate => Str

The ending date to retrieve alarm history.

HistoryItemType => Str

The type of alarm histories to retrieve.

Valid values are: "ConfigurationUpdate", "StateUpdate", "Action"

MaxRecords => Int

The maximum number of alarm history records to retrieve.

NextToken => Str

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

ScanBy => Str

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

Valid values are: "TimestampDescending", "TimestampAscending"

StartDate => Str

The starting date to retrieve alarm history.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeAlarmHistory 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

cpanm Paws

perl -MCPAN -e shell
install Paws