aws-sdk-alexaforbusiness 1.20.0 → 1.21.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 57d1d641192496d3d27adbcf06e6a86aa9cd9297
4
- data.tar.gz: 7f17956f2259174296b381abd072a4cb3ef34b60
3
+ metadata.gz: 28944a6796b279dcf8616ec422cad7cb7af4d390
4
+ data.tar.gz: c8096cda5665b36ac02d9e7932f6d6f5c1d4124b
5
5
  SHA512:
6
- metadata.gz: 561e56b65e713bbdc617afc1de8407496b0b62cc6fd1dff189d5cb2015221e8b8c43fd566c0dbe500cbd63ff7912a39b1dd856bd81973ec5890a6a857426c483
7
- data.tar.gz: 7f54ece6a2855072128b19abb18bcef28e866d81d74ea62580a5fc4a3caafbb7337b6eb4c3feff868d96a0470965eed4ffc38461ee4cb3708e213ca66969476e
6
+ metadata.gz: 9bf8cf0b0f014837c34c749dc638a875ed7e8572576dad02ae9f85c02ff79cbaa3b5eeb32b6b0ffe97e00c9adde0c8232fa11649d36cf154ea9070f36649bf41
7
+ data.tar.gz: cdb5336341127b1cfd9768ef12dab08527178923be4d550708f2c90d9d6a95a868f765eca439644869586af3f62c7551adb03272896134bd51d8fc3ad0c58d5f
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-alexaforbusiness/customizations'
42
42
  # @service
43
43
  module Aws::AlexaForBusiness
44
44
 
45
- GEM_VERSION = '1.20.0'
45
+ GEM_VERSION = '1.21.0'
46
46
 
47
47
  end
@@ -2947,6 +2947,81 @@ module Aws::AlexaForBusiness
2947
2947
  req.send_request(options)
2948
2948
  end
2949
2949
 
2950
+ # Triggers an asynchronous flow to send text, SSML, or audio
2951
+ # announcements to multiple rooms, identified by a search, such as
2952
+ # filter.
2953
+ #
2954
+ # @option params [required, Array<Types::Filter>] :room_filters
2955
+ # The filters to use to send an announcement to a specified list of
2956
+ # rooms. The supported filter keys are RoomName, ProfileName, RoomArn,
2957
+ # and ProfileArn. To send to all rooms, specify an empty RoomFilters
2958
+ # list.
2959
+ #
2960
+ # @option params [required, Types::Content] :content
2961
+ # The announcement content. This can contain only one of the three
2962
+ # possible announcement types (text, SSML or audio).
2963
+ #
2964
+ # @option params [Integer] :time_to_live_in_seconds
2965
+ # The time to live for an announcement. If delivery doesn't occur
2966
+ # within this time, the announcement will not be delivered.
2967
+ #
2968
+ # @option params [required, String] :client_request_token
2969
+ # The unique, user-specified identifier for the request that ensures
2970
+ # idempotency.
2971
+ #
2972
+ # **A suitable default value is auto-generated.** You should normally
2973
+ # not need to pass this option.**
2974
+ #
2975
+ # @return [Types::SendAnnouncementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2976
+ #
2977
+ # * {Types::SendAnnouncementResponse#announcement_arn #announcement_arn} => String
2978
+ #
2979
+ # @example Request syntax with placeholder values
2980
+ #
2981
+ # resp = client.send_announcement({
2982
+ # room_filters: [ # required
2983
+ # {
2984
+ # key: "FilterKey", # required
2985
+ # values: ["FilterValue"], # required
2986
+ # },
2987
+ # ],
2988
+ # content: { # required
2989
+ # text_list: [
2990
+ # {
2991
+ # locale: "en-US", # required, accepts en-US
2992
+ # value: "TextValue", # required
2993
+ # },
2994
+ # ],
2995
+ # ssml_list: [
2996
+ # {
2997
+ # locale: "en-US", # required, accepts en-US
2998
+ # value: "SsmlValue", # required
2999
+ # },
3000
+ # ],
3001
+ # audio_list: [
3002
+ # {
3003
+ # locale: "en-US", # required, accepts en-US
3004
+ # location: "AudioLocation", # required
3005
+ # },
3006
+ # ],
3007
+ # },
3008
+ # time_to_live_in_seconds: 1,
3009
+ # client_request_token: "ClientRequestToken", # required
3010
+ # })
3011
+ #
3012
+ # @example Response structure
3013
+ #
3014
+ # resp.announcement_arn #=> String
3015
+ #
3016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SendAnnouncement AWS API Documentation
3017
+ #
3018
+ # @overload send_announcement(params = {})
3019
+ # @param [Hash] params ({})
3020
+ def send_announcement(params = {}, options = {})
3021
+ req = build_request(:send_announcement, params)
3022
+ req.send_request(options)
3023
+ end
3024
+
2950
3025
  # Sends an enrollment invitation email with a URL to a user. The URL is
2951
3026
  # valid for 72 hours or until you call this operation again, whichever
2952
3027
  # comes first.
@@ -3484,7 +3559,7 @@ module Aws::AlexaForBusiness
3484
3559
  params: params,
3485
3560
  config: config)
3486
3561
  context[:gem_name] = 'aws-sdk-alexaforbusiness'
3487
- context[:gem_version] = '1.20.0'
3562
+ context[:gem_version] = '1.21.0'
3488
3563
  Seahorse::Client::Request.new(handlers, context)
3489
3564
  end
3490
3565
 
@@ -35,12 +35,16 @@ module Aws::AlexaForBusiness
35
35
  AssociateSkillWithSkillGroupResponse = Shapes::StructureShape.new(name: 'AssociateSkillWithSkillGroupResponse')
36
36
  AssociateSkillWithUsersRequest = Shapes::StructureShape.new(name: 'AssociateSkillWithUsersRequest')
37
37
  AssociateSkillWithUsersResponse = Shapes::StructureShape.new(name: 'AssociateSkillWithUsersResponse')
38
+ Audio = Shapes::StructureShape.new(name: 'Audio')
39
+ AudioList = Shapes::ListShape.new(name: 'AudioList')
40
+ AudioLocation = Shapes::StringShape.new(name: 'AudioLocation')
38
41
  AuthorizationResult = Shapes::MapShape.new(name: 'AuthorizationResult')
39
42
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
40
43
  BulletPoint = Shapes::StringShape.new(name: 'BulletPoint')
41
44
  BulletPoints = Shapes::ListShape.new(name: 'BulletPoints')
42
45
  BusinessReport = Shapes::StructureShape.new(name: 'BusinessReport')
43
46
  BusinessReportContentRange = Shapes::StructureShape.new(name: 'BusinessReportContentRange')
47
+ BusinessReportDeliveryTime = Shapes::TimestampShape.new(name: 'BusinessReportDeliveryTime')
44
48
  BusinessReportDownloadUrl = Shapes::StringShape.new(name: 'BusinessReportDownloadUrl')
45
49
  BusinessReportFailureCode = Shapes::StringShape.new(name: 'BusinessReportFailureCode')
46
50
  BusinessReportFormat = Shapes::StringShape.new(name: 'BusinessReportFormat')
@@ -70,6 +74,7 @@ module Aws::AlexaForBusiness
70
74
  ContactData = Shapes::StructureShape.new(name: 'ContactData')
71
75
  ContactDataList = Shapes::ListShape.new(name: 'ContactDataList')
72
76
  ContactName = Shapes::StringShape.new(name: 'ContactName')
77
+ Content = Shapes::StructureShape.new(name: 'Content')
73
78
  CountryCode = Shapes::StringShape.new(name: 'CountryCode')
74
79
  CreateAddressBookRequest = Shapes::StructureShape.new(name: 'CreateAddressBookRequest')
75
80
  CreateAddressBookResponse = Shapes::StructureShape.new(name: 'CreateAddressBookResponse')
@@ -122,6 +127,7 @@ module Aws::AlexaForBusiness
122
127
  DeviceDataList = Shapes::ListShape.new(name: 'DeviceDataList')
123
128
  DeviceEvent = Shapes::StructureShape.new(name: 'DeviceEvent')
124
129
  DeviceEventList = Shapes::ListShape.new(name: 'DeviceEventList')
130
+ DeviceEventTime = Shapes::TimestampShape.new(name: 'DeviceEventTime')
125
131
  DeviceEventType = Shapes::StringShape.new(name: 'DeviceEventType')
126
132
  DeviceEventValue = Shapes::StringShape.new(name: 'DeviceEventValue')
127
133
  DeviceName = Shapes::StringShape.new(name: 'DeviceName')
@@ -228,6 +234,7 @@ module Aws::AlexaForBusiness
228
234
  ListSmartHomeAppliancesResponse = Shapes::StructureShape.new(name: 'ListSmartHomeAppliancesResponse')
229
235
  ListTagsRequest = Shapes::StructureShape.new(name: 'ListTagsRequest')
230
236
  ListTagsResponse = Shapes::StructureShape.new(name: 'ListTagsResponse')
237
+ Locale = Shapes::StringShape.new(name: 'Locale')
231
238
  MacAddress = Shapes::StringShape.new(name: 'MacAddress')
232
239
  MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
233
240
  MaxVolumeLimit = Shapes::IntegerShape.new(name: 'MaxVolumeLimit')
@@ -297,6 +304,8 @@ module Aws::AlexaForBusiness
297
304
  SearchSkillGroupsResponse = Shapes::StructureShape.new(name: 'SearchSkillGroupsResponse')
298
305
  SearchUsersRequest = Shapes::StructureShape.new(name: 'SearchUsersRequest')
299
306
  SearchUsersResponse = Shapes::StructureShape.new(name: 'SearchUsersResponse')
307
+ SendAnnouncementRequest = Shapes::StructureShape.new(name: 'SendAnnouncementRequest')
308
+ SendAnnouncementResponse = Shapes::StructureShape.new(name: 'SendAnnouncementResponse')
300
309
  SendInvitationRequest = Shapes::StructureShape.new(name: 'SendInvitationRequest')
301
310
  SendInvitationResponse = Shapes::StructureShape.new(name: 'SendInvitationResponse')
302
311
  ShortDescription = Shapes::StringShape.new(name: 'ShortDescription')
@@ -326,6 +335,9 @@ module Aws::AlexaForBusiness
326
335
  SortKey = Shapes::StringShape.new(name: 'SortKey')
327
336
  SortList = Shapes::ListShape.new(name: 'SortList')
328
337
  SortValue = Shapes::StringShape.new(name: 'SortValue')
338
+ Ssml = Shapes::StructureShape.new(name: 'Ssml')
339
+ SsmlList = Shapes::ListShape.new(name: 'SsmlList')
340
+ SsmlValue = Shapes::StringShape.new(name: 'SsmlValue')
329
341
  StartDeviceSyncRequest = Shapes::StructureShape.new(name: 'StartDeviceSyncRequest')
330
342
  StartDeviceSyncResponse = Shapes::StructureShape.new(name: 'StartDeviceSyncResponse')
331
343
  StartSmartHomeApplianceDiscoveryRequest = Shapes::StructureShape.new(name: 'StartSmartHomeApplianceDiscoveryRequest')
@@ -338,7 +350,10 @@ module Aws::AlexaForBusiness
338
350
  TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
339
351
  TagValue = Shapes::StringShape.new(name: 'TagValue')
340
352
  TemperatureUnit = Shapes::StringShape.new(name: 'TemperatureUnit')
341
- Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
353
+ Text = Shapes::StructureShape.new(name: 'Text')
354
+ TextList = Shapes::ListShape.new(name: 'TextList')
355
+ TextValue = Shapes::StringShape.new(name: 'TextValue')
356
+ TimeToLiveInSeconds = Shapes::IntegerShape.new(name: 'TimeToLiveInSeconds')
342
357
  Timezone = Shapes::StringShape.new(name: 'Timezone')
343
358
  TotalCount = Shapes::IntegerShape.new(name: 'TotalCount')
344
359
  UnauthorizedException = Shapes::StructureShape.new(name: 'UnauthorizedException')
@@ -423,6 +438,12 @@ module Aws::AlexaForBusiness
423
438
 
424
439
  AssociateSkillWithUsersResponse.struct_class = Types::AssociateSkillWithUsersResponse
425
440
 
441
+ Audio.add_member(:locale, Shapes::ShapeRef.new(shape: Locale, required: true, location_name: "Locale"))
442
+ Audio.add_member(:location, Shapes::ShapeRef.new(shape: AudioLocation, required: true, location_name: "Location"))
443
+ Audio.struct_class = Types::Audio
444
+
445
+ AudioList.member = Shapes::ShapeRef.new(shape: Audio)
446
+
426
447
  AuthorizationResult.key = Shapes::ShapeRef.new(shape: Key)
427
448
  AuthorizationResult.value = Shapes::ShapeRef.new(shape: Value)
428
449
 
@@ -431,7 +452,7 @@ module Aws::AlexaForBusiness
431
452
  BusinessReport.add_member(:status, Shapes::ShapeRef.new(shape: BusinessReportStatus, location_name: "Status"))
432
453
  BusinessReport.add_member(:failure_code, Shapes::ShapeRef.new(shape: BusinessReportFailureCode, location_name: "FailureCode"))
433
454
  BusinessReport.add_member(:s3_location, Shapes::ShapeRef.new(shape: BusinessReportS3Location, location_name: "S3Location"))
434
- BusinessReport.add_member(:delivery_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "DeliveryTime"))
455
+ BusinessReport.add_member(:delivery_time, Shapes::ShapeRef.new(shape: BusinessReportDeliveryTime, location_name: "DeliveryTime"))
435
456
  BusinessReport.add_member(:download_url, Shapes::ShapeRef.new(shape: BusinessReportDownloadUrl, location_name: "DownloadUrl"))
436
457
  BusinessReport.struct_class = Types::BusinessReport
437
458
 
@@ -492,6 +513,11 @@ module Aws::AlexaForBusiness
492
513
 
493
514
  ContactDataList.member = Shapes::ShapeRef.new(shape: ContactData)
494
515
 
516
+ Content.add_member(:text_list, Shapes::ShapeRef.new(shape: TextList, location_name: "TextList"))
517
+ Content.add_member(:ssml_list, Shapes::ShapeRef.new(shape: SsmlList, location_name: "SsmlList"))
518
+ Content.add_member(:audio_list, Shapes::ShapeRef.new(shape: AudioList, location_name: "AudioList"))
519
+ Content.struct_class = Types::Content
520
+
495
521
  CreateAddressBookRequest.add_member(:name, Shapes::ShapeRef.new(shape: AddressBookName, required: true, location_name: "Name"))
496
522
  CreateAddressBookRequest.add_member(:description, Shapes::ShapeRef.new(shape: AddressBookDescription, location_name: "Description"))
497
523
  CreateAddressBookRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
@@ -683,7 +709,7 @@ module Aws::AlexaForBusiness
683
709
 
684
710
  DeviceEvent.add_member(:type, Shapes::ShapeRef.new(shape: DeviceEventType, location_name: "Type"))
685
711
  DeviceEvent.add_member(:value, Shapes::ShapeRef.new(shape: DeviceEventValue, location_name: "Value"))
686
- DeviceEvent.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Timestamp"))
712
+ DeviceEvent.add_member(:timestamp, Shapes::ShapeRef.new(shape: DeviceEventTime, location_name: "Timestamp"))
687
713
  DeviceEvent.struct_class = Types::DeviceEvent
688
714
 
689
715
  DeviceEventList.member = Shapes::ShapeRef.new(shape: DeviceEvent)
@@ -1135,6 +1161,15 @@ module Aws::AlexaForBusiness
1135
1161
  SearchUsersResponse.add_member(:total_count, Shapes::ShapeRef.new(shape: TotalCount, location_name: "TotalCount"))
1136
1162
  SearchUsersResponse.struct_class = Types::SearchUsersResponse
1137
1163
 
1164
+ SendAnnouncementRequest.add_member(:room_filters, Shapes::ShapeRef.new(shape: FilterList, required: true, location_name: "RoomFilters"))
1165
+ SendAnnouncementRequest.add_member(:content, Shapes::ShapeRef.new(shape: Content, required: true, location_name: "Content"))
1166
+ SendAnnouncementRequest.add_member(:time_to_live_in_seconds, Shapes::ShapeRef.new(shape: TimeToLiveInSeconds, location_name: "TimeToLiveInSeconds"))
1167
+ SendAnnouncementRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, required: true, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
1168
+ SendAnnouncementRequest.struct_class = Types::SendAnnouncementRequest
1169
+
1170
+ SendAnnouncementResponse.add_member(:announcement_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AnnouncementArn"))
1171
+ SendAnnouncementResponse.struct_class = Types::SendAnnouncementResponse
1172
+
1138
1173
  SendInvitationRequest.add_member(:user_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "UserArn"))
1139
1174
  SendInvitationRequest.struct_class = Types::SendInvitationRequest
1140
1175
 
@@ -1201,6 +1236,12 @@ module Aws::AlexaForBusiness
1201
1236
 
1202
1237
  SortList.member = Shapes::ShapeRef.new(shape: Sort)
1203
1238
 
1239
+ Ssml.add_member(:locale, Shapes::ShapeRef.new(shape: Locale, required: true, location_name: "Locale"))
1240
+ Ssml.add_member(:value, Shapes::ShapeRef.new(shape: SsmlValue, required: true, location_name: "Value"))
1241
+ Ssml.struct_class = Types::Ssml
1242
+
1243
+ SsmlList.member = Shapes::ShapeRef.new(shape: Ssml)
1244
+
1204
1245
  StartDeviceSyncRequest.add_member(:room_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "RoomArn"))
1205
1246
  StartDeviceSyncRequest.add_member(:device_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "DeviceArn"))
1206
1247
  StartDeviceSyncRequest.add_member(:features, Shapes::ShapeRef.new(shape: Features, required: true, location_name: "Features"))
@@ -1227,6 +1268,12 @@ module Aws::AlexaForBusiness
1227
1268
 
1228
1269
  TagResourceResponse.struct_class = Types::TagResourceResponse
1229
1270
 
1271
+ Text.add_member(:locale, Shapes::ShapeRef.new(shape: Locale, required: true, location_name: "Locale"))
1272
+ Text.add_member(:value, Shapes::ShapeRef.new(shape: TextValue, required: true, location_name: "Value"))
1273
+ Text.struct_class = Types::Text
1274
+
1275
+ TextList.member = Shapes::ShapeRef.new(shape: Text)
1276
+
1230
1277
  UntagResourceRequest.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "Arn"))
1231
1278
  UntagResourceRequest.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location_name: "TagKeys"))
1232
1279
  UntagResourceRequest.struct_class = Types::UntagResourceRequest
@@ -2101,6 +2148,16 @@ module Aws::AlexaForBusiness
2101
2148
  )
2102
2149
  end)
2103
2150
 
2151
+ api.add_operation(:send_announcement, Seahorse::Model::Operation.new.tap do |o|
2152
+ o.name = "SendAnnouncement"
2153
+ o.http_method = "POST"
2154
+ o.http_request_uri = "/"
2155
+ o.input = Shapes::ShapeRef.new(shape: SendAnnouncementRequest)
2156
+ o.output = Shapes::ShapeRef.new(shape: SendAnnouncementResponse)
2157
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
2158
+ o.errors << Shapes::ShapeRef.new(shape: AlreadyExistsException)
2159
+ end)
2160
+
2104
2161
  api.add_operation(:send_invitation, Seahorse::Model::Operation.new.tap do |o|
2105
2162
  o.name = "SendInvitation"
2106
2163
  o.http_method = "POST"
@@ -211,6 +211,54 @@ module Aws::AlexaForBusiness
211
211
  #
212
212
  class AssociateSkillWithUsersResponse < Aws::EmptyStructure; end
213
213
 
214
+ # The audio message. There is a 1 MB limit on the audio file input, and
215
+ # the only supported format is MP3. You must convert audio files to an
216
+ # Alexa-friendly format.
217
+ #
218
+ # You might need to use converter software to convert your MP3 files to
219
+ # the required codec version (MPEG version 2) and bit rate (48 kbps).
220
+ # One option for this is a command-line tool, FFmpeg. For more
221
+ # information, see [FFmpeg][1]. The following command converts the
222
+ # provided &lt;input-file&gt; to an MP3 file that will be played in the
223
+ # announcement:
224
+ #
225
+ # `ffmpeg -i <input-file> -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000
226
+ # <output-file.mp3>`
227
+ #
228
+ #
229
+ #
230
+ # [1]: https://www.ffmpeg.org/
231
+ #
232
+ # @note When making an API call, you may pass Audio
233
+ # data as a hash:
234
+ #
235
+ # {
236
+ # locale: "en-US", # required, accepts en-US
237
+ # location: "AudioLocation", # required
238
+ # }
239
+ #
240
+ # @!attribute [rw] locale
241
+ # The locale of the audio message. Currently, en-US is supported.
242
+ # @return [String]
243
+ #
244
+ # @!attribute [rw] location
245
+ # The location of the audio file. Currently, S3 URLs are supported.
246
+ # Only S3 locations comprised of safe character are valid. For more
247
+ # information, see [Safe Characters][1].
248
+ #
249
+ #
250
+ #
251
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#Safe%20Characters
252
+ # @return [String]
253
+ #
254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Audio AWS API Documentation
255
+ #
256
+ class Audio < Struct.new(
257
+ :locale,
258
+ :location)
259
+ include Aws::Structure
260
+ end
261
+
214
262
  # Usage report with specified parameters.
215
263
  #
216
264
  # @!attribute [rw] status
@@ -505,6 +553,54 @@ module Aws::AlexaForBusiness
505
553
  include Aws::Structure
506
554
  end
507
555
 
556
+ # The content definition. It can contain only one text, SSML, or audio
557
+ # list object.
558
+ #
559
+ # @note When making an API call, you may pass Content
560
+ # data as a hash:
561
+ #
562
+ # {
563
+ # text_list: [
564
+ # {
565
+ # locale: "en-US", # required, accepts en-US
566
+ # value: "TextValue", # required
567
+ # },
568
+ # ],
569
+ # ssml_list: [
570
+ # {
571
+ # locale: "en-US", # required, accepts en-US
572
+ # value: "SsmlValue", # required
573
+ # },
574
+ # ],
575
+ # audio_list: [
576
+ # {
577
+ # locale: "en-US", # required, accepts en-US
578
+ # location: "AudioLocation", # required
579
+ # },
580
+ # ],
581
+ # }
582
+ #
583
+ # @!attribute [rw] text_list
584
+ # The list of text messages.
585
+ # @return [Array<Types::Text>]
586
+ #
587
+ # @!attribute [rw] ssml_list
588
+ # The list of SSML messages.
589
+ # @return [Array<Types::Ssml>]
590
+ #
591
+ # @!attribute [rw] audio_list
592
+ # The list of audio messages.
593
+ # @return [Array<Types::Audio>]
594
+ #
595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Content AWS API Documentation
596
+ #
597
+ class Content < Struct.new(
598
+ :text_list,
599
+ :ssml_list,
600
+ :audio_list)
601
+ include Aws::Structure
602
+ end
603
+
508
604
  # @note When making an API call, you may pass CreateAddressBookRequest
509
605
  # data as a hash:
510
606
  #
@@ -3833,6 +3929,86 @@ module Aws::AlexaForBusiness
3833
3929
  include Aws::Structure
3834
3930
  end
3835
3931
 
3932
+ # @note When making an API call, you may pass SendAnnouncementRequest
3933
+ # data as a hash:
3934
+ #
3935
+ # {
3936
+ # room_filters: [ # required
3937
+ # {
3938
+ # key: "FilterKey", # required
3939
+ # values: ["FilterValue"], # required
3940
+ # },
3941
+ # ],
3942
+ # content: { # required
3943
+ # text_list: [
3944
+ # {
3945
+ # locale: "en-US", # required, accepts en-US
3946
+ # value: "TextValue", # required
3947
+ # },
3948
+ # ],
3949
+ # ssml_list: [
3950
+ # {
3951
+ # locale: "en-US", # required, accepts en-US
3952
+ # value: "SsmlValue", # required
3953
+ # },
3954
+ # ],
3955
+ # audio_list: [
3956
+ # {
3957
+ # locale: "en-US", # required, accepts en-US
3958
+ # location: "AudioLocation", # required
3959
+ # },
3960
+ # ],
3961
+ # },
3962
+ # time_to_live_in_seconds: 1,
3963
+ # client_request_token: "ClientRequestToken", # required
3964
+ # }
3965
+ #
3966
+ # @!attribute [rw] room_filters
3967
+ # The filters to use to send an announcement to a specified list of
3968
+ # rooms. The supported filter keys are RoomName, ProfileName, RoomArn,
3969
+ # and ProfileArn. To send to all rooms, specify an empty RoomFilters
3970
+ # list.
3971
+ # @return [Array<Types::Filter>]
3972
+ #
3973
+ # @!attribute [rw] content
3974
+ # The announcement content. This can contain only one of the three
3975
+ # possible announcement types (text, SSML or audio).
3976
+ # @return [Types::Content]
3977
+ #
3978
+ # @!attribute [rw] time_to_live_in_seconds
3979
+ # The time to live for an announcement. If delivery doesn't occur
3980
+ # within this time, the announcement will not be delivered.
3981
+ # @return [Integer]
3982
+ #
3983
+ # @!attribute [rw] client_request_token
3984
+ # The unique, user-specified identifier for the request that ensures
3985
+ # idempotency.
3986
+ #
3987
+ # **A suitable default value is auto-generated.** You should normally
3988
+ # not need to pass this option.
3989
+ # @return [String]
3990
+ #
3991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SendAnnouncementRequest AWS API Documentation
3992
+ #
3993
+ class SendAnnouncementRequest < Struct.new(
3994
+ :room_filters,
3995
+ :content,
3996
+ :time_to_live_in_seconds,
3997
+ :client_request_token)
3998
+ include Aws::Structure
3999
+ end
4000
+
4001
+ # @!attribute [rw] announcement_arn
4002
+ # The identifier of the announcement.
4003
+ # @return [String]
4004
+ #
4005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SendAnnouncementResponse AWS API Documentation
4006
+ #
4007
+ class SendAnnouncementResponse < Struct.new(
4008
+ :announcement_arn)
4009
+ include Aws::Structure
4010
+ end
4011
+
3836
4012
  # @note When making an API call, you may pass SendInvitationRequest
3837
4013
  # data as a hash:
3838
4014
  #
@@ -4088,6 +4264,37 @@ module Aws::AlexaForBusiness
4088
4264
  include Aws::Structure
4089
4265
  end
4090
4266
 
4267
+ # The SSML message. For more information, see [SSML Reference][1].
4268
+ #
4269
+ #
4270
+ #
4271
+ # [1]: https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html
4272
+ #
4273
+ # @note When making an API call, you may pass Ssml
4274
+ # data as a hash:
4275
+ #
4276
+ # {
4277
+ # locale: "en-US", # required, accepts en-US
4278
+ # value: "SsmlValue", # required
4279
+ # }
4280
+ #
4281
+ # @!attribute [rw] locale
4282
+ # The locale of the SSML message. Currently, en-US is supported.
4283
+ # @return [String]
4284
+ #
4285
+ # @!attribute [rw] value
4286
+ # The value of the SSML message in the correct SSML format. The audio
4287
+ # tag is not supported.
4288
+ # @return [String]
4289
+ #
4290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Ssml AWS API Documentation
4291
+ #
4292
+ class Ssml < Struct.new(
4293
+ :locale,
4294
+ :value)
4295
+ include Aws::Structure
4296
+ end
4297
+
4091
4298
  # @note When making an API call, you may pass StartDeviceSyncRequest
4092
4299
  # data as a hash:
4093
4300
  #
@@ -4205,6 +4412,32 @@ module Aws::AlexaForBusiness
4205
4412
  #
4206
4413
  class TagResourceResponse < Aws::EmptyStructure; end
4207
4414
 
4415
+ # The text message.
4416
+ #
4417
+ # @note When making an API call, you may pass Text
4418
+ # data as a hash:
4419
+ #
4420
+ # {
4421
+ # locale: "en-US", # required, accepts en-US
4422
+ # value: "TextValue", # required
4423
+ # }
4424
+ #
4425
+ # @!attribute [rw] locale
4426
+ # The locale of the text message. Currently, en-US is supported.
4427
+ # @return [String]
4428
+ #
4429
+ # @!attribute [rw] value
4430
+ # The value of the text message.
4431
+ # @return [String]
4432
+ #
4433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Text AWS API Documentation
4434
+ #
4435
+ class Text < Struct.new(
4436
+ :locale,
4437
+ :value)
4438
+ include Aws::Structure
4439
+ end
4440
+
4208
4441
  # @note When making an API call, you may pass UntagResourceRequest
4209
4442
  # data as a hash:
4210
4443
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-alexaforbusiness
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.20.0
4
+ version: 1.21.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-04-24 00:00:00.000000000 Z
11
+ date: 2019-05-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core