CloudWatch / Paginator / ListAlarmMuteRules

ListAlarmMuteRules

class CloudWatch.Paginator.ListAlarmMuteRules
paginator = client.get_paginator('list_alarm_mute_rules')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AlarmName='string',
    Statuses=[
        'SCHEDULED'|'ACTIVE'|'EXPIRED',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • AlarmName (string) – Filter results to show only mute rules that target the specified alarm name.

  • Statuses (list) –

    Filter results to show only mute rules with the specified statuses. Valid values are SCHEDULED, ACTIVE, or EXPIRED.

    • (string) –

  • 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

{
    'AlarmMuteRuleSummaries': [
        {
            'AlarmMuteRuleArn': 'string',
            'ExpireDate': datetime(2015, 1, 1),
            'Status': 'SCHEDULED'|'ACTIVE'|'EXPIRED',
            'MuteType': 'string',
            'LastUpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) –

    • AlarmMuteRuleSummaries (list) –

      A list of alarm mute rule summaries.

      • (dict) –

        Summary information about an alarm mute rule, including its name, status, and configuration details.

        • AlarmMuteRuleArn (string) –

          The Amazon Resource Name (ARN) of the alarm mute rule.

        • ExpireDate (datetime) –

          The date and time when the mute rule expires and is no longer evaluated. This field is only present if an expiration date was configured.

        • Status (string) –

          The current status of the alarm mute rule. Valid values are SCHEDULED, ACTIVE, or EXPIRED.

        • MuteType (string) –

          Indicates whether the mute rule is one-time or recurring. Valid values are ONE_TIME or RECURRING.

        • LastUpdatedTimestamp (datetime) –

          The date and time when the mute rule was last updated.