UserNotifications / Client / list_managed_notification_channel_associations

list_managed_notification_channel_associations

UserNotifications.Client.list_managed_notification_channel_associations(**kwargs)

Returns a list of Account contacts and Channels associated with a ManagedNotificationConfiguration, in paginated format.

See also: AWS API Documentation

Request Syntax

response = client.list_managed_notification_channel_associations(
    managedNotificationConfigurationArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • managedNotificationConfigurationArn (string) –

    [REQUIRED]

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

  • maxResults (integer) – The maximum number of results to be returned in this call. Defaults to 20.

  • nextToken (string) – The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

    • 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 Amazon Q Developer in chat applications 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.

Exceptions

  • UserNotifications.Client.exceptions.AccessDeniedException

  • UserNotifications.Client.exceptions.ValidationException

  • UserNotifications.Client.exceptions.InternalServerException

  • UserNotifications.Client.exceptions.ResourceNotFoundException

  • UserNotifications.Client.exceptions.ThrottlingException