Amazonka.DirectoryService.DescribeEventTopics

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.

Creating a Request

data DescribeEventTopics

Describes event topics.

See: newDescribeEventTopics smart constructor.

Constructors

DescribeEventTopics'

Fields

• directoryId :: Maybe Text

  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 :: Maybe [Text]

  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.

Instances

ToJSON DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

toJSON :: DescribeEventTopics -> Value

toEncoding :: DescribeEventTopics -> Encoding

toJSONList :: [DescribeEventTopics] -> Value

toEncodingList :: [DescribeEventTopics] -> Encoding

ToHeaders DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

toHeaders :: DescribeEventTopics -> [Header]

ToPath DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

toPath :: DescribeEventTopics -> ByteString

ToQuery DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

toQuery :: DescribeEventTopics -> QueryString

AWSRequest DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

Associated Types

type AWSResponse DescribeEventTopics

Methods

request :: (Service -> Service) -> DescribeEventTopics -> Request DescribeEventTopics

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEventTopics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEventTopics)))

Generic DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

Associated Types

type Rep DescribeEventTopics :: Type -> Type

Methods

from :: DescribeEventTopics -> Rep DescribeEventTopics x

to :: Rep DescribeEventTopics x -> DescribeEventTopics

Read DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

readsPrec :: Int -> ReadS DescribeEventTopics

readList :: ReadS [DescribeEventTopics]

readPrec :: ReadPrec DescribeEventTopics

readListPrec :: ReadPrec [DescribeEventTopics]

Show DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

showsPrec :: Int -> DescribeEventTopics -> ShowS

show :: DescribeEventTopics -> String

showList :: [DescribeEventTopics] -> ShowS

NFData DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

rnf :: DescribeEventTopics -> ()

Eq DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

(==) :: DescribeEventTopics -> DescribeEventTopics -> Bool

(/=) :: DescribeEventTopics -> DescribeEventTopics -> Bool

Hashable DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

hashWithSalt :: Int -> DescribeEventTopics -> Int

hash :: DescribeEventTopics -> Int

type AWSResponse DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

type AWSResponse DescribeEventTopics = DescribeEventTopicsResponse

type Rep DescribeEventTopics

Defined in Amazonka.DirectoryService.DescribeEventTopics

type Rep DescribeEventTopics = D1 ('MetaData "DescribeEventTopics" "Amazonka.DirectoryService.DescribeEventTopics" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeEventTopics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "topicNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newDescribeEventTopics :: DescribeEventTopics

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:

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)

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

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

The result of a DescribeEventTopic request.

See: newDescribeEventTopicsResponse smart constructor.

Constructors

DescribeEventTopicsResponse'

Fields

• eventTopics :: Maybe [EventTopic]

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeEventTopicsResponse

Defined in Amazonka.DirectoryService.DescribeEventTopics

Associated Types

type Rep DescribeEventTopicsResponse :: Type -> Type

Methods

from :: DescribeEventTopicsResponse -> Rep DescribeEventTopicsResponse x

to :: Rep DescribeEventTopicsResponse x -> DescribeEventTopicsResponse

Read DescribeEventTopicsResponse

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

readsPrec :: Int -> ReadS DescribeEventTopicsResponse

readList :: ReadS [DescribeEventTopicsResponse]

readPrec :: ReadPrec DescribeEventTopicsResponse

readListPrec :: ReadPrec [DescribeEventTopicsResponse]

Show DescribeEventTopicsResponse

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

showsPrec :: Int -> DescribeEventTopicsResponse -> ShowS

show :: DescribeEventTopicsResponse -> String

showList :: [DescribeEventTopicsResponse] -> ShowS

NFData DescribeEventTopicsResponse

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

rnf :: DescribeEventTopicsResponse -> ()

Eq DescribeEventTopicsResponse

Defined in Amazonka.DirectoryService.DescribeEventTopics

Methods

(==) :: DescribeEventTopicsResponse -> DescribeEventTopicsResponse -> Bool

(/=) :: DescribeEventTopicsResponse -> DescribeEventTopicsResponse -> Bool

type Rep DescribeEventTopicsResponse

Defined in Amazonka.DirectoryService.DescribeEventTopics

type Rep DescribeEventTopicsResponse = D1 ('MetaData "DescribeEventTopicsResponse" "Amazonka.DirectoryService.DescribeEventTopics" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeEventTopicsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventTopics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventTopic])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeEventTopicsResponse

Arguments

:: Int

$sel:httpStatus:DescribeEventTopicsResponse'

-> DescribeEventTopicsResponse

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

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

describeEventTopicsResponse_httpStatus :: Lens' DescribeEventTopicsResponse Int

The response's http status code.