UserNotifications / Paginator / ListManagedNotificationChannelAssociations

ListManagedNotificationChannelAssociations

class UserNotifications.Paginator.ListManagedNotificationChannelAssociations

paginator = client.get_paginator('list_managed_notification_channel_associations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• managedNotificationConfigurationArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to match.

• 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

{
    'channelAssociations': [
        {
            'channelIdentifier': 'string',
            'channelType': 'MOBILE'|'CHATBOT'|'EMAIL'|'ACCOUNT_CONTACT',
            'overrideOption': 'ENABLED'|'DISABLED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • channelAssociations (list) –

    A list that contains the following information about a channel association.

    • (dict) –

      Provides a summary of channel associations for a managed notification configuration.

      • channelIdentifier (string) –

        The unique identifier for the notification channel.

      • channelType (string) –

        The type of notification channel used for message delivery.

        • Values:

          • ACCOUNT_CONTACT

            • Delivers notifications to Account Managed contacts through the User Notification Service.

          • MOBILE

            • Delivers notifications through the Amazon Web Services Console Mobile Application to mobile devices.

          • CHATBOT

            • Delivers notifications through Chatbot to collaboration platforms (Slack, Chime).

          • EMAIL

            • Delivers notifications to email addresses.

      • overrideOption (string) –

        Controls whether users can modify channel associations for a notification configuration.

        • Values:

          • ENABLED

            • Users can associate or disassociate channels with the notification configuration.

          • DISABLED

            • Users cannot associate or disassociate channels with the notification configuration.

  • NextToken (string) –

    A token to resume pagination.