AWS Directory Service

Removes the specified directory as a publisher to the specified SNS topic.

Request Syntax

client.deregister_event_topic(
    DirectoryId='string',
    TopicName='string'
)

type DirectoryId

string

param DirectoryId

[REQUIRED]

The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic.

type TopicName

string

param TopicName

[REQUIRED]

The name of the SNS topic from which to remove the directory as a publisher.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified 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.

Request Syntax

client.register_event_topic(
    DirectoryId='string',
    TopicName='string'
)

type DirectoryId

string

param DirectoryId

[REQUIRED]

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

type TopicName

string

param TopicName

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Obtains information about which SNS topics receive status messages from the specified directory.

If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

Request Syntax

client.describe_event_topics(
    DirectoryId='string',
    TopicNames=[
        'string',
    ]
)

type DirectoryId

string

param DirectoryId

The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.

type TopicNames

list

param TopicNames

A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

An empty list results in an InvalidParameterException being thrown.

• (string) --

rtype

dict

returns

Response Syntax

{
    'EventTopics': [
        {
            'DirectoryId': 'string',
            'TopicName': 'string',
            'TopicArn': 'string',
            'CreatedDateTime': datetime(2015, 1, 1),
            'Status': 'Registered'|'Topic not found'|'Failed'|'Deleted'
        },
    ]
}

Response Structure

• (dict) --

  • EventTopics (list) --

    A list of SNS topic names that receive status messages from the specified Directory ID.

    • (dict) --

      Information about SNS topic and AWS Directory Service directory associations.

      • DirectoryId (string) --

        The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.

      • TopicName (string) --

        The name of an AWS SNS topic the receives status messages from the directory.

      • TopicArn (string) --

        The SNS topic ARN (Amazon Resource Name).

      • CreatedDateTime (datetime) --

        The date and time of when you associated your directory with the SNS topic.

      • Status (string) --

        The topic registration status.