DirectoryService / Client / register_event_topic

register_event_topic#

DirectoryService.Client.register_event_topic(**kwargs)#

Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

See also: AWS API Documentation

Request Syntax

response = client.register_event_topic(
    DirectoryId='string',
    TopicName='string'
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    The Directory ID that will publish status messages to the Amazon SNS topic.

  • TopicName (string) –

    [REQUIRED]

    The Amazon SNS topic name to which the directory will publish status messages. This Amazon SNS topic must be in the same region as the specified Directory ID.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The result of a RegisterEventTopic request.

Exceptions

  • DirectoryService.Client.exceptions.EntityDoesNotExistException

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException