Class: Aws::AlexaForBusiness::Types::SendAnnouncementRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::SendAnnouncementRequest
- Defined in:
- gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb
Overview
When making an API call, you may pass SendAnnouncementRequest data as a 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
}
Constant Summary collapse
- SENSITIVE =
[]
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.
A suitable default value is auto-generated. You should normally not need to pass this option.
5282 5283 5284 5285 5286 5287 5288 5289 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5282 class SendAnnouncementRequest < Struct.new( :room_filters, :content, :time_to_live_in_seconds, :client_request_token) SENSITIVE = [] include Aws::Structure end |
#content ⇒ Types::Content
The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).
5282 5283 5284 5285 5286 5287 5288 5289 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5282 class SendAnnouncementRequest < Struct.new( :room_filters, :content, :time_to_live_in_seconds, :client_request_token) SENSITIVE = [] include Aws::Structure end |
#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.
5282 5283 5284 5285 5286 5287 5288 5289 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5282 class SendAnnouncementRequest < Struct.new( :room_filters, :content, :time_to_live_in_seconds, :client_request_token) SENSITIVE = [] include Aws::Structure end |
#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.
5282 5283 5284 5285 5286 5287 5288 5289 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5282 class SendAnnouncementRequest < Struct.new( :room_filters, :content, :time_to_live_in_seconds, :client_request_token) SENSITIVE = [] include Aws::Structure end |