| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.DirectoryService.DescribeEventTopics
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.
Synopsis
- data DescribeEventTopics = DescribeEventTopics' {
- directoryId :: Maybe Text
- topicNames :: Maybe [Text]
- newDescribeEventTopics :: DescribeEventTopics
- describeEventTopics_directoryId :: Lens' DescribeEventTopics (Maybe Text)
- describeEventTopics_topicNames :: Lens' DescribeEventTopics (Maybe [Text])
- data DescribeEventTopicsResponse = DescribeEventTopicsResponse' {
- eventTopics :: Maybe [EventTopic]
- httpStatus :: Int
- newDescribeEventTopicsResponse :: Int -> DescribeEventTopicsResponse
- describeEventTopicsResponse_eventTopics :: Lens' DescribeEventTopicsResponse (Maybe [EventTopic])
- describeEventTopicsResponse_httpStatus :: Lens' DescribeEventTopicsResponse Int
Creating a Request
data DescribeEventTopics Source #
Describes event topics.
See: newDescribeEventTopics smart constructor.
Constructors
| DescribeEventTopics' | |
Fields
| |
Instances
newDescribeEventTopics :: DescribeEventTopics Source #
Create a value of DescribeEventTopics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryId:DescribeEventTopics', describeEventTopics_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.
$sel:topicNames:DescribeEventTopics', describeEventTopics_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.
Request Lenses
describeEventTopics_directoryId :: Lens' DescribeEventTopics (Maybe Text) Source #
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.
describeEventTopics_topicNames :: Lens' DescribeEventTopics (Maybe [Text]) Source #
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.
Destructuring the Response
data DescribeEventTopicsResponse Source #
The result of a DescribeEventTopic request.
See: newDescribeEventTopicsResponse smart constructor.
Constructors
| DescribeEventTopicsResponse' | |
Fields
| |
Instances
newDescribeEventTopicsResponse Source #
Create a value of DescribeEventTopicsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventTopics:DescribeEventTopicsResponse', describeEventTopicsResponse_eventTopics - A list of Amazon SNS topic names that receive status messages from the
specified Directory ID.
$sel:httpStatus:DescribeEventTopicsResponse', describeEventTopicsResponse_httpStatus - The response's http status code.
Response Lenses
describeEventTopicsResponse_eventTopics :: Lens' DescribeEventTopicsResponse (Maybe [EventTopic]) Source #
A list of Amazon SNS topic names that receive status messages from the specified Directory ID.
describeEventTopicsResponse_httpStatus :: Lens' DescribeEventTopicsResponse Int Source #
The response's http status code.