You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

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
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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)


4691
4692
4693
4694
4695
4696
4697
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4691

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

#contentTypes::Content

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

Returns:



4691
4692
4693
4694
4695
4696
4697
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4691

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

#room_filtersArray<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:



4691
4692
4693
4694
4695
4696
4697
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4691

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

#time_to_live_in_secondsInteger

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)


4691
4692
4693
4694
4695
4696
4697
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4691

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