DirectoryService / Client / describe_event_topics

describe_event_topics#

DirectoryService.Client.describe_event_topics(**kwargs)#

Obtains information about which Amazon 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.

See also: AWS API Documentation

Request Syntax

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

  • DirectoryId (string) – The Directory ID for which to get the list of associated Amazon SNS topics. If this member is null, associations for all Directory IDs are returned.

  • TopicNames (list) –

    A list of Amazon 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) –

Return type:

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) –

    The result of a DescribeEventTopic request.

    • EventTopics (list) –

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

      • (dict) –

        Information about Amazon SNS topic and Directory Service directory associations.

        • DirectoryId (string) –

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

        • TopicName (string) –

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

        • TopicArn (string) –

          The Amazon SNS topic ARN (Amazon Resource Name).

        • CreatedDateTime (datetime) –

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

        • Status (string) –

          The topic registration status.

Exceptions

  • DirectoryService.Client.exceptions.EntityDoesNotExistException

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException