UserNotifications / Client / deregister_notification_hub

deregister_notification_hub#

UserNotifications.Client.deregister_notification_hub(**kwargs)#

Deregisters a NotificationConfiguration in the specified Region.

Note

You can’t deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationConfiguration are no longer be visible. Recreating a new NotificationConfiguration in the same Region restores access to those NotificationEvents.

See also: AWS API Documentation

Request Syntax

response = client.deregister_notification_hub(
    notificationHubRegion='string'
)
Parameters:

notificationHubRegion (string) –

[REQUIRED]

The NotificationConfiguration Region.

Return type:

dict

Returns:

Response Syntax

{
    'notificationHubRegion': 'string',
    'statusSummary': {
        'status': 'ACTIVE'|'REGISTERING'|'DEREGISTERING'|'INACTIVE',
        'reason': 'string'
    }
}

Response Structure

  • (dict) –

    • notificationHubRegion (string) –

      The NotificationConfiguration Region.

    • statusSummary (dict) –

      NotificationConfiguration status information.

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

Exceptions