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.AlexaBusiness.SendAnnouncement

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

Creating a Request

data SendAnnouncement Source #

See: newSendAnnouncement smart constructor.

Constructors

SendAnnouncement'

Fields

timeToLiveInSeconds :: Maybe Natural
The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.
roomFilters :: [Filter]
The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.
content :: Content
The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).
clientRequestToken :: Text
The unique, user-specified identifier for the request that ensures idempotency.

Instances

Instances details

Eq SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods (==) :: SendAnnouncement -> SendAnnouncement -> Bool # (/=) :: SendAnnouncement -> SendAnnouncement -> Bool #
Read SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods readsPrec :: Int -> ReadS SendAnnouncement # readList :: ReadS [SendAnnouncement] # readPrec :: ReadPrec SendAnnouncement # readListPrec :: ReadPrec [SendAnnouncement] #
Show SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods showsPrec :: Int -> SendAnnouncement -> ShowS # show :: SendAnnouncement -> String # showList :: [SendAnnouncement] -> ShowS #
Generic SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Associated Types type Rep SendAnnouncement :: Type -> Type # Methods from :: SendAnnouncement -> Rep SendAnnouncement x # to :: Rep SendAnnouncement x -> SendAnnouncement #
NFData SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods rnf :: SendAnnouncement -> () #
Hashable SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods hashWithSalt :: Int -> SendAnnouncement -> Int # hash :: SendAnnouncement -> Int #
ToJSON SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods toJSON :: SendAnnouncement -> Value # toEncoding :: SendAnnouncement -> Encoding # toJSONList :: [SendAnnouncement] -> Value # toEncodingList :: [SendAnnouncement] -> Encoding #
AWSRequest SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Associated Types type AWSResponse SendAnnouncement # Methods request :: SendAnnouncement -> Request SendAnnouncement # response :: MonadResource m => Logger -> Service -> Proxy SendAnnouncement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendAnnouncement))) #
ToHeaders SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods toHeaders :: SendAnnouncement -> [Header] #
ToPath SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods toPath :: SendAnnouncement -> ByteString #
ToQuery SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods toQuery :: SendAnnouncement -> QueryString #
type Rep SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement type Rep SendAnnouncement = D1 ('MetaData "SendAnnouncement" "Amazonka.AlexaBusiness.SendAnnouncement" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "SendAnnouncement'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "timeToLiveInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "roomFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Filter])) :: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Content) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SendAnnouncement Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement type AWSResponse SendAnnouncement = SendAnnouncementResponse

newSendAnnouncement Source #

Arguments

:: Content	`$sel:content:SendAnnouncement'`
-> Text	`$sel:clientRequestToken:SendAnnouncement'`
-> SendAnnouncement

Create a value of SendAnnouncement 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:timeToLiveInSeconds:SendAnnouncement', sendAnnouncement_timeToLiveInSeconds - The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

$sel:roomFilters:SendAnnouncement', sendAnnouncement_roomFilters - The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

$sel:content:SendAnnouncement', sendAnnouncement_content - The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

$sel:clientRequestToken:SendAnnouncement', sendAnnouncement_clientRequestToken - The unique, user-specified identifier for the request that ensures idempotency.

Request Lenses

sendAnnouncement_timeToLiveInSeconds :: Lens' SendAnnouncement (Maybe Natural) Source #

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

sendAnnouncement_roomFilters :: Lens' SendAnnouncement [Filter] Source #

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

sendAnnouncement_content :: Lens' SendAnnouncement Content Source #

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

sendAnnouncement_clientRequestToken :: Lens' SendAnnouncement Text Source #

The unique, user-specified identifier for the request that ensures idempotency.

Destructuring the Response

data SendAnnouncementResponse Source #

See: newSendAnnouncementResponse smart constructor.

Constructors

SendAnnouncementResponse'
Fields announcementArn :: Maybe Text The identifier of the announcement. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SendAnnouncementResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods (==) :: SendAnnouncementResponse -> SendAnnouncementResponse -> Bool # (/=) :: SendAnnouncementResponse -> SendAnnouncementResponse -> Bool #
Read SendAnnouncementResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods readsPrec :: Int -> ReadS SendAnnouncementResponse # readList :: ReadS [SendAnnouncementResponse] # readPrec :: ReadPrec SendAnnouncementResponse # readListPrec :: ReadPrec [SendAnnouncementResponse] #
Show SendAnnouncementResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods showsPrec :: Int -> SendAnnouncementResponse -> ShowS # show :: SendAnnouncementResponse -> String # showList :: [SendAnnouncementResponse] -> ShowS #
Generic SendAnnouncementResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Associated Types type Rep SendAnnouncementResponse :: Type -> Type # Methods from :: SendAnnouncementResponse -> Rep SendAnnouncementResponse x # to :: Rep SendAnnouncementResponse x -> SendAnnouncementResponse #
NFData SendAnnouncementResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement Methods rnf :: SendAnnouncementResponse -> () #
type Rep SendAnnouncementResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SendAnnouncement type Rep SendAnnouncementResponse = D1 ('MetaData "SendAnnouncementResponse" "Amazonka.AlexaBusiness.SendAnnouncement" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "SendAnnouncementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "announcementArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSendAnnouncementResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendAnnouncementResponse'`
-> SendAnnouncementResponse

Create a value of SendAnnouncementResponse 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:announcementArn:SendAnnouncementResponse', sendAnnouncementResponse_announcementArn - The identifier of the announcement.

$sel:httpStatus:SendAnnouncementResponse', sendAnnouncementResponse_httpStatus - The response's http status code.

Response Lenses

sendAnnouncementResponse_announcementArn :: Lens' SendAnnouncementResponse (Maybe Text) Source #

The identifier of the announcement.

sendAnnouncementResponse_httpStatus :: Lens' SendAnnouncementResponse Int Source #

The response's http status code.