You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::AlexaForBusiness::Types::SendAnnouncementRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::SendAnnouncementRequest
- Defined in:
- (unknown)
Overview
When passing SendAnnouncementRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
room_filters: [ # required
{
key: "FilterKey", # required
values: ["FilterValue"], # required
},
],
content: { # required
text_list: [
{
locale: "en-US", # required, accepts en-US
value: "TextValue", # required
},
],
ssml_list: [
{
locale: "en-US", # required, accepts en-US
value: "SsmlValue", # required
},
],
audio_list: [
{
locale: "en-US", # required, accepts en-US
location: "AudioLocation", # required
},
],
},
time_to_live_in_seconds: 1,
client_request_token: "ClientRequestToken", # required
}
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
The unique, user-specified identifier for the request that ensures idempotency.
-
#content ⇒ Types::Content
The announcement content.
-
#room_filters ⇒ Array<Types::Filter>
The filters to use to send an announcement to a specified list of rooms.
-
#time_to_live_in_seconds ⇒ Integer
The time to live for an announcement.
Instance Attribute Details
#client_request_token ⇒ String
The unique, user-specified identifier for the request that ensures idempotency.
#content ⇒ Types::Content
The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).
#room_filters ⇒ Array<Types::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.
#time_to_live_in_seconds ⇒ Integer
The time to live for an announcement. Default is 300. If delivery doesn\'t occur within this time, the announcement is not delivered.