libZSservicesZSamazonka-dsZSamazonka-ds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DirectoryService.RegisterEventTopic

Description

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

Synopsis

Creating a Request

data RegisterEventTopic Source #

Registers a new event topic.

See: newRegisterEventTopic smart constructor.

Constructors

RegisterEventTopic' 

Fields

  • directoryId :: Text

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

  • topicName :: Text

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

Instances

Instances details
Eq RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

Read RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

Show RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

Generic RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

Associated Types

type Rep RegisterEventTopic :: Type -> Type #

NFData RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

Methods

rnf :: RegisterEventTopic -> () #

Hashable RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

ToJSON RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

AWSRequest RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

Associated Types

type AWSResponse RegisterEventTopic #

ToHeaders RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

ToPath RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

ToQuery RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

type Rep RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

type Rep RegisterEventTopic = D1 ('MetaData "RegisterEventTopic" "Amazonka.DirectoryService.RegisterEventTopic" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "RegisterEventTopic'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "topicName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse RegisterEventTopic Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

newRegisterEventTopic Source #

Create a value of RegisterEventTopic 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:RegisterEventTopic', registerEventTopic_directoryId - The Directory ID that will publish status messages to the Amazon SNS topic.

$sel:topicName:RegisterEventTopic', registerEventTopic_topicName - The Amazon SNS topic name to which the directory will publish status messages. This Amazon SNS topic must be in the same region as the specified Directory ID.

Request Lenses

registerEventTopic_directoryId :: Lens' RegisterEventTopic Text Source #

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

registerEventTopic_topicName :: Lens' RegisterEventTopic Text Source #

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

Destructuring the Response

data RegisterEventTopicResponse Source #

The result of a RegisterEventTopic request.

See: newRegisterEventTopicResponse smart constructor.

Constructors

RegisterEventTopicResponse' 

Fields

Instances

Instances details
Eq RegisterEventTopicResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

Read RegisterEventTopicResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

Show RegisterEventTopicResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

Generic RegisterEventTopicResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

Associated Types

type Rep RegisterEventTopicResponse :: Type -> Type #

NFData RegisterEventTopicResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

type Rep RegisterEventTopicResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.RegisterEventTopic

type Rep RegisterEventTopicResponse = D1 ('MetaData "RegisterEventTopicResponse" "Amazonka.DirectoryService.RegisterEventTopic" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "RegisterEventTopicResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterEventTopicResponse Source #

Create a value of RegisterEventTopicResponse 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:httpStatus:RegisterEventTopicResponse', registerEventTopicResponse_httpStatus - The response's http status code.

Response Lenses