UserNotifications / Client / list_notification_hubs

list_notification_hubs#

UserNotifications.Client.list_notification_hubs(**kwargs)#

Returns a list of NotificationHubs.

See also: AWS API Documentation

Request Syntax

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

  • maxResults (integer) – The maximum number of records to list in a single response.

  • nextToken (string) – A pagination token. Set to null to start listing notification hubs from the start.

Return type:

dict

Returns:

Response Syntax

{
    'notificationHubs': [
        {
            'notificationHubRegion': 'string',
            'statusSummary': {
                'status': 'ACTIVE'|'REGISTERING'|'DEREGISTERING'|'INACTIVE',
                'reason': 'string'
            },
            'creationTime': datetime(2015, 1, 1),
            'lastActivationTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • notificationHubs (list) –

      The NotificationHubs in the account.

      • (dict) –

        Describes an overview of a NotificationHub.

        A NotificationConfiguration is an account-level setting used to select the Regions where you want to store, process and replicate your notifications.

        • notificationHubRegion (string) –

          The Region of the resource.

        • statusSummary (dict) –

          The status summary of the resource.

          • status (string) –

            Status information about the NotificationHub.

            • Values:

              • ACTIVE

                • Incoming NotificationEvents are replicated to this NotificationHub.

              • REGISTERING

                • The NotificationConfiguration is initializing. A NotificationConfiguration with this status can’t be deregistered.

              • DEREGISTERING

                • The NotificationConfiguration is being deleted. You can’t register additional NotificationHubs in the same Region as a NotificationConfiguration with this status.

          • reason (string) –

            An explanation for the current status.

        • creationTime (datetime) –

          The date and time the NotificationHubOverview was created.

        • lastActivationTime (datetime) –

          The most recent time this NotificationHub had an ACTIVE status.

    • 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.

Exceptions

  • UserNotifications.Client.exceptions.AccessDeniedException

  • UserNotifications.Client.exceptions.ValidationException

  • UserNotifications.Client.exceptions.InternalServerException

  • UserNotifications.Client.exceptions.ThrottlingException