UserNotifications / Paginator / ListNotificationConfigurations

ListNotificationConfigurations

class UserNotifications.Paginator.ListNotificationConfigurations

paginator = client.get_paginator('list_notification_configurations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    eventRuleSource='string',
    channelArn='string',
    status='ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• eventRuleSource (string) –

  The matched event source.

  Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.

• channelArn (string) – The Amazon Resource Name (ARN) of the Channel to match.

• status (string) –

  The NotificationConfiguration status to match.

  • Values:

    • ACTIVE

      • All EventRules are ACTIVE and any call can be run.

    • PARTIALLY_ACTIVE

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

      • Any call can be run.

    • INACTIVE

      • All EventRules are INACTIVE and any call can be run.

    • DELETING

      • This NotificationConfiguration is being deleted.

      • Only GET and LIST calls can be run.

• 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

{
    'notificationConfigurations': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
            'creationTime': datetime(2015, 1, 1),
            'aggregationDuration': 'LONG'|'SHORT'|'NONE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • notificationConfigurations (list) –

    The NotificationConfigurations in the account.

    • (dict) –

      Contains the complete list of fields for a NotificationConfiguration.

      • arn (string) –

        The Amazon Resource Name (ARN) of the resource.

      • name (string) –

        The name of the NotificationConfiguration. Supports RFC 3986’s unreserved characters.

      • description (string) –

        The description of the NotificationConfiguration.

      • status (string) –

        The status of this NotificationConfiguration.

        The status should always be INACTIVE when part of the CreateNotificationConfiguration response.

        • Values:

          • ACTIVE

            • All EventRules are ACTIVE and any call can be run.

          • PARTIALLY_ACTIVE

            • Some EventRules are ACTIVE and some are INACTIVE.

            • Any call can be run.

          • INACTIVE

            • All EventRules are INACTIVE and any call can be run.

          • DELETING

            • This NotificationConfiguration is being deleted. Only GET and LIST calls can be run.

            • Only GET and LIST calls can be run.

      • creationTime (datetime) –

        The creation time of the resource.

      • aggregationDuration (string) –

        The aggregation preference of the NotificationConfiguration.

        • Values:

          • LONG

            • Aggregate notifications for long periods of time (12 hours).

          • SHORT

            • Aggregate notifications for short periods of time (5 minutes).

          • NONE

            • Don’t aggregate notifications. No delay in delivery.

  • NextToken (string) –

    A token to resume pagination.