UserNotifications / Client / register_notification_hub

register_notification_hub#

UserNotifications.Client.register_notification_hub(**kwargs)#

Registers a NotificationHub in the specified Region.

There is a maximum of one NotificationHub per Region. You can have a maximum of 3 NotificationHubs at a time.

Request Syntax

response = client.register_notification_hub(
    notificationHubRegion='string'
)

Parameters:

notificationHubRegion (string) –

[REQUIRED]

The Region of the NotificationHub.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- notificationHubRegion (string) –
  
  The Region of the NotificationHub.
- statusSummary (dict) –
  
  NotificationHub status information.
  - status (string) –
    
    Status information about the NotificationHub.
    - Values:
      - ACTIVE
        
        Incoming NotificationEvents are replicated to this NotificationHub.
      - REGISTERING
        
        The NotificationHub is initializing. A NotificationHub with this status can’t be deregistered.
      - DEREGISTERING
        
        The NotificationHub is being deleted. You can’t register additional NotificationHubs in the same Region as a NotificationHub with this status.
  - reason (string) –
    
    An Explanation for the current status.
- creationTime (datetime) –
  
  The date the resource was created.
- lastActivationTime (datetime) –
  
  The date the resource was last activated.

Exceptions

UserNotifications.Client.exceptions.ServiceQuotaExceededException
UserNotifications.Client.exceptions.AccessDeniedException
UserNotifications.Client.exceptions.ValidationException
UserNotifications.Client.exceptions.InternalServerException
UserNotifications.Client.exceptions.ThrottlingException
UserNotifications.Client.exceptions.ConflictException