UserNotifications / Paginator / ListEventRules

ListEventRules

class UserNotifications.Paginator.ListEventRules

paginator = client.get_paginator('list_event_rules')

paginate(**kwargs)

Creates an iterator that will paginate through responses from UserNotifications.Client.list_event_rules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    notificationConfigurationArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• notificationConfigurationArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the NotificationConfiguration.

• 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

{
    'eventRules': [
        {
            'arn': 'string',
            'notificationConfigurationArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'source': 'string',
            'eventType': 'string',
            'eventPattern': 'string',
            'regions': [
                'string',
            ],
            'managedRules': [
                'string',
            ],
            'statusSummaryByRegion': {
                'string': {
                    'status': 'ACTIVE'|'INACTIVE'|'CREATING'|'UPDATING'|'DELETING',
                    'reason': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • eventRules (list) –

    A list of EventRules.

    • (dict) –

      Contains a complete list of fields related to an EventRule.

      • arn (string) –

        The Amazon Resource Name (ARN) of the EventRule. CloudFormation stack generates this ARN and then uses this ARN to associate with the NotificationConfiguration.

      • notificationConfigurationArn (string) –

        The ARN for the NotificationConfiguration associated with this EventRule.

      • creationTime (datetime) –

        The creation time of the EventRule.

      • source (string) –

        The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

      • eventType (string) –

        The event type this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

      • eventPattern (string) –

        An additional event pattern used to further filter the events this EventRule receives.

        For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

      • regions (list) –

        A list of Amazon Web Services Regions that send events to this EventRule.

        • (string) –

      • managedRules (list) –

        A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.

        Note

        These are created by User Notifications within your account so your EventRules can function.

        • (string) –

      • statusSummaryByRegion (dict) –

        A list of an EventRule’s status by Region. Regions are mapped to EventRuleStatusSummary.

        • (string) –

          • (dict) –

            Provides additional information about the current EventRule status.

            • status (string) –

              The status of the EventRule.

              • Values:

                • ACTIVE

                  • The EventRule can process events.

                • INACTIVE

                  • The EventRule may be unable to process events.

                • CREATING

                  • The EventRule is being created. Only GET and LIST calls can be run.

                • UPDATING

                  • The EventRule is being updated. Only GET and LIST calls can be run.

                • DELETING

                  • The EventRule is being deleted. Only GET and LIST calls can be run.

            • reason (string) –

              A human-readable reason for EventRuleStatus.

  • NextToken (string) –

    A token to resume pagination.