Class: Aws::AlexaForBusiness::Types::SendAnnouncementRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


4268
4269
4270
4271
4272
4273
4274
4275
 
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4268

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

Returns:



4268
4269
4270
4271
4272
4273
4274
4275
 
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4268

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.

Returns:



4268
4269
4270
4271
4272
4273
4274
4275
 
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4268

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.

Returns:

  • (Integer) 


4268
4269
4270
4271
4272
4273
4274
4275
 
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4268

class SendAnnouncementRequest < Struct.new(
  :room_filters,
  :content,
  :time_to_live_in_seconds,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end