Describe Event Topics

directoryservice_describe_event_topics

R Documentation

Description¶

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.

Usage¶

directoryservice_describe_event_topics(DirectoryId, TopicNames)

Arguments¶

DirectoryId

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

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.

Value¶

A list with the following syntax:

list(
  EventTopics = list(
    list(
      DirectoryId = "string",
      TopicName = "string",
      TopicArn = "string",
      CreatedDateTime = as.POSIXct(
        "2015-01-01"
      ),
      Status = "Registered"|"Topic not found"|"Failed"|"Deleted"
    )
  )
)

Request syntax¶

svc$describe_event_topics(
  DirectoryId = "string",
  TopicNames = list(
    "string"
  )
)