CloudWatch / Paginator / DescribeAlarmHistory

DescribeAlarmHistory

class CloudWatch.Paginator.DescribeAlarmHistory

paginator = client.get_paginator('describe_alarm_history')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatch.Client.describe_alarm_history().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AlarmName='string',
    AlarmContributorId='string',
    AlarmTypes=[
        'CompositeAlarm'|'MetricAlarm',
    ],
    HistoryItemType='ConfigurationUpdate'|'StateUpdate'|'Action'|'AlarmContributorStateUpdate'|'AlarmContributorAction',
    StartDate=datetime(2015, 1, 1),
    EndDate=datetime(2015, 1, 1),
    ScanBy='TimestampDescending'|'TimestampAscending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AlarmName (string) – The name of the alarm.

• AlarmContributorId (string) – The unique identifier of a specific alarm contributor to filter the alarm history results.

• AlarmTypes (list) –

  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.

  • (string) –

• HistoryItemType (string) – The type of alarm histories to retrieve.

• StartDate (datetime) – The starting date to retrieve alarm history.

• EndDate (datetime) – The ending date to retrieve alarm history.

• ScanBy (string) – 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'AlarmHistoryItems': [
        {
            'AlarmName': 'string',
            'AlarmContributorId': 'string',
            'AlarmType': 'CompositeAlarm'|'MetricAlarm',
            'Timestamp': datetime(2015, 1, 1),
            'HistoryItemType': 'ConfigurationUpdate'|'StateUpdate'|'Action'|'AlarmContributorStateUpdate'|'AlarmContributorAction',
            'HistorySummary': 'string',
            'HistoryData': 'string',
            'AlarmContributorAttributes': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • AlarmHistoryItems (list) –

    The alarm histories, in JSON format.

    • (dict) –

      Represents the history of a specific alarm.

      • AlarmName (string) –

        The descriptive name for the alarm.

      • AlarmContributorId (string) –

        The unique identifier of the alarm contributor associated with this history item, if applicable.

      • AlarmType (string) –

        The type of alarm, either metric alarm or composite alarm.

      • Timestamp (datetime) –

        The time stamp for the alarm history item.

      • HistoryItemType (string) –

        The type of alarm history item.

      • HistorySummary (string) –

        A summary of the alarm history, in text format.

      • HistoryData (string) –

        Data about the alarm, in JSON format.

      • AlarmContributorAttributes (dict) –

        A map of attributes that describe the alarm contributor associated with this history item, providing context about the contributor’s characteristics at the time of the event.

        • (string) –

          • (string) –