aws-sdk-alexaforbusiness 1.10.0 → 1.11.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-alexaforbusiness.rb +1 -1
- data/lib/aws-sdk-alexaforbusiness/client.rb +803 -103
- data/lib/aws-sdk-alexaforbusiness/client_api.rb +568 -2
- data/lib/aws-sdk-alexaforbusiness/types.rb +1092 -25
- metadata +2 -2
@@ -54,6 +54,28 @@ module Aws::AlexaForBusiness
|
|
54
54
|
include Aws::Structure
|
55
55
|
end
|
56
56
|
|
57
|
+
# @note When making an API call, you may pass ApproveSkillRequest
|
58
|
+
# data as a hash:
|
59
|
+
#
|
60
|
+
# {
|
61
|
+
# skill_id: "SkillId", # required
|
62
|
+
# }
|
63
|
+
#
|
64
|
+
# @!attribute [rw] skill_id
|
65
|
+
# The unique identifier of the skill.
|
66
|
+
# @return [String]
|
67
|
+
#
|
68
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ApproveSkillRequest AWS API Documentation
|
69
|
+
#
|
70
|
+
class ApproveSkillRequest < Struct.new(
|
71
|
+
:skill_id)
|
72
|
+
include Aws::Structure
|
73
|
+
end
|
74
|
+
|
75
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ApproveSkillResponse AWS API Documentation
|
76
|
+
#
|
77
|
+
class ApproveSkillResponse < Aws::EmptyStructure; end
|
78
|
+
|
57
79
|
# @note When making an API call, you may pass AssociateContactWithAddressBookRequest
|
58
80
|
# data as a hash:
|
59
81
|
#
|
@@ -139,6 +161,116 @@ module Aws::AlexaForBusiness
|
|
139
161
|
#
|
140
162
|
class AssociateSkillGroupWithRoomResponse < Aws::EmptyStructure; end
|
141
163
|
|
164
|
+
# @note When making an API call, you may pass AssociateSkillWithSkillGroupRequest
|
165
|
+
# data as a hash:
|
166
|
+
#
|
167
|
+
# {
|
168
|
+
# skill_group_arn: "Arn",
|
169
|
+
# skill_id: "SkillId", # required
|
170
|
+
# }
|
171
|
+
#
|
172
|
+
# @!attribute [rw] skill_group_arn
|
173
|
+
# The ARN of the skill group to associate the skill to.
|
174
|
+
# @return [String]
|
175
|
+
#
|
176
|
+
# @!attribute [rw] skill_id
|
177
|
+
# The unique identifier of the skill.
|
178
|
+
# @return [String]
|
179
|
+
#
|
180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateSkillWithSkillGroupRequest AWS API Documentation
|
181
|
+
#
|
182
|
+
class AssociateSkillWithSkillGroupRequest < Struct.new(
|
183
|
+
:skill_group_arn,
|
184
|
+
:skill_id)
|
185
|
+
include Aws::Structure
|
186
|
+
end
|
187
|
+
|
188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateSkillWithSkillGroupResponse AWS API Documentation
|
189
|
+
#
|
190
|
+
class AssociateSkillWithSkillGroupResponse < Aws::EmptyStructure; end
|
191
|
+
|
192
|
+
# The skill store category that is shown. Alexa skills are assigned a
|
193
|
+
# specific skill category during creation, such as News, Social, and
|
194
|
+
# Sports.
|
195
|
+
#
|
196
|
+
# @!attribute [rw] category_id
|
197
|
+
# The ID of the skill store category.
|
198
|
+
# @return [Integer]
|
199
|
+
#
|
200
|
+
# @!attribute [rw] category_name
|
201
|
+
# The name of the skill store category.
|
202
|
+
# @return [String]
|
203
|
+
#
|
204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Category AWS API Documentation
|
205
|
+
#
|
206
|
+
class Category < Struct.new(
|
207
|
+
:category_id,
|
208
|
+
:category_name)
|
209
|
+
include Aws::Structure
|
210
|
+
end
|
211
|
+
|
212
|
+
# The default conference provider that is used if no other scheduled
|
213
|
+
# meetings are detected.
|
214
|
+
#
|
215
|
+
# @note When making an API call, you may pass ConferencePreference
|
216
|
+
# data as a hash:
|
217
|
+
#
|
218
|
+
# {
|
219
|
+
# default_conference_provider_arn: "Arn",
|
220
|
+
# }
|
221
|
+
#
|
222
|
+
# @!attribute [rw] default_conference_provider_arn
|
223
|
+
# The ARN of the default conference provider.
|
224
|
+
# @return [String]
|
225
|
+
#
|
226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ConferencePreference AWS API Documentation
|
227
|
+
#
|
228
|
+
class ConferencePreference < Struct.new(
|
229
|
+
:default_conference_provider_arn)
|
230
|
+
include Aws::Structure
|
231
|
+
end
|
232
|
+
|
233
|
+
# An entity that provides a conferencing solution. Alexa for Business
|
234
|
+
# acts as the voice interface and mediator that connects users to their
|
235
|
+
# preferred conference provider. Examples of conference providers
|
236
|
+
# include Amazon Chime, Zoom, Cisco, and Polycom.
|
237
|
+
#
|
238
|
+
# @!attribute [rw] arn
|
239
|
+
# The ARN of the newly created conference provider.
|
240
|
+
# @return [String]
|
241
|
+
#
|
242
|
+
# @!attribute [rw] name
|
243
|
+
# The name of the conference provider.
|
244
|
+
# @return [String]
|
245
|
+
#
|
246
|
+
# @!attribute [rw] type
|
247
|
+
# The type of conference providers.
|
248
|
+
# @return [String]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] ip_dial_in
|
251
|
+
# The IP endpoint and protocol for calling.
|
252
|
+
# @return [Types::IPDialIn]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] pstn_dial_in
|
255
|
+
# The information for PSTN conferencing.
|
256
|
+
# @return [Types::PSTNDialIn]
|
257
|
+
#
|
258
|
+
# @!attribute [rw] meeting_setting
|
259
|
+
# The meeting settings for the conference provider.
|
260
|
+
# @return [Types::MeetingSetting]
|
261
|
+
#
|
262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ConferenceProvider AWS API Documentation
|
263
|
+
#
|
264
|
+
class ConferenceProvider < Struct.new(
|
265
|
+
:arn,
|
266
|
+
:name,
|
267
|
+
:type,
|
268
|
+
:ip_dial_in,
|
269
|
+
:pstn_dial_in,
|
270
|
+
:meeting_setting)
|
271
|
+
include Aws::Structure
|
272
|
+
end
|
273
|
+
|
142
274
|
# A contact with attributes.
|
143
275
|
#
|
144
276
|
# @!attribute [rw] contact_arn
|
@@ -254,6 +386,78 @@ module Aws::AlexaForBusiness
|
|
254
386
|
include Aws::Structure
|
255
387
|
end
|
256
388
|
|
389
|
+
# @note When making an API call, you may pass CreateConferenceProviderRequest
|
390
|
+
# data as a hash:
|
391
|
+
#
|
392
|
+
# {
|
393
|
+
# conference_provider_name: "ConferenceProviderName", # required
|
394
|
+
# conference_provider_type: "CHIME", # required, accepts CHIME, BLUEJEANS, FUZE, GOOGLE_HANGOUTS, POLYCOM, RINGCENTRAL, SKYPE_FOR_BUSINESS, WEBEX, ZOOM, CUSTOM
|
395
|
+
# ip_dial_in: {
|
396
|
+
# endpoint: "Endpoint", # required
|
397
|
+
# comms_protocol: "SIP", # required, accepts SIP, SIPS, H323
|
398
|
+
# },
|
399
|
+
# pstn_dial_in: {
|
400
|
+
# country_code: "CountryCode", # required
|
401
|
+
# phone_number: "PhoneNumber", # required
|
402
|
+
# one_click_id_delay: "OneClickIdDelay", # required
|
403
|
+
# one_click_pin_delay: "OneClickPinDelay", # required
|
404
|
+
# },
|
405
|
+
# meeting_setting: { # required
|
406
|
+
# require_pin: "YES", # required, accepts YES, NO, OPTIONAL
|
407
|
+
# },
|
408
|
+
# client_request_token: "ClientRequestToken",
|
409
|
+
# }
|
410
|
+
#
|
411
|
+
# @!attribute [rw] conference_provider_name
|
412
|
+
# The name of the conference provider.
|
413
|
+
# @return [String]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] conference_provider_type
|
416
|
+
# A string that represents a type within a list of predefined types.
|
417
|
+
# @return [String]
|
418
|
+
#
|
419
|
+
# @!attribute [rw] ip_dial_in
|
420
|
+
# The IP endpoint and protocol for calling.
|
421
|
+
# @return [Types::IPDialIn]
|
422
|
+
#
|
423
|
+
# @!attribute [rw] pstn_dial_in
|
424
|
+
# The information for PSTN conferencing.
|
425
|
+
# @return [Types::PSTNDialIn]
|
426
|
+
#
|
427
|
+
# @!attribute [rw] meeting_setting
|
428
|
+
# The meeting settings for the conference provider.
|
429
|
+
# @return [Types::MeetingSetting]
|
430
|
+
#
|
431
|
+
# @!attribute [rw] client_request_token
|
432
|
+
# The request token of the client.
|
433
|
+
#
|
434
|
+
# **A suitable default value is auto-generated.** You should normally
|
435
|
+
# not need to pass this option.
|
436
|
+
# @return [String]
|
437
|
+
#
|
438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateConferenceProviderRequest AWS API Documentation
|
439
|
+
#
|
440
|
+
class CreateConferenceProviderRequest < Struct.new(
|
441
|
+
:conference_provider_name,
|
442
|
+
:conference_provider_type,
|
443
|
+
:ip_dial_in,
|
444
|
+
:pstn_dial_in,
|
445
|
+
:meeting_setting,
|
446
|
+
:client_request_token)
|
447
|
+
include Aws::Structure
|
448
|
+
end
|
449
|
+
|
450
|
+
# @!attribute [rw] conference_provider_arn
|
451
|
+
# The ARN of the newly created conference provider.
|
452
|
+
# @return [String]
|
453
|
+
#
|
454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateConferenceProviderResponse AWS API Documentation
|
455
|
+
#
|
456
|
+
class CreateConferenceProviderResponse < Struct.new(
|
457
|
+
:conference_provider_arn)
|
458
|
+
include Aws::Structure
|
459
|
+
end
|
460
|
+
|
257
461
|
# @note When making an API call, you may pass CreateContactRequest
|
258
462
|
# data as a hash:
|
259
463
|
#
|
@@ -411,8 +615,8 @@ module Aws::AlexaForBusiness
|
|
411
615
|
# client_request_token: "ClientRequestToken",
|
412
616
|
# tags: [
|
413
617
|
# {
|
414
|
-
# key: "TagKey",
|
415
|
-
# value: "TagValue",
|
618
|
+
# key: "TagKey", # required
|
619
|
+
# value: "TagValue", # required
|
416
620
|
# },
|
417
621
|
# ],
|
418
622
|
# }
|
@@ -524,8 +728,8 @@ module Aws::AlexaForBusiness
|
|
524
728
|
# client_request_token: "ClientRequestToken",
|
525
729
|
# tags: [
|
526
730
|
# {
|
527
|
-
# key: "TagKey",
|
528
|
-
# value: "TagValue",
|
731
|
+
# key: "TagKey", # required
|
732
|
+
# value: "TagValue", # required
|
529
733
|
# },
|
530
734
|
# ],
|
531
735
|
# }
|
@@ -603,6 +807,28 @@ module Aws::AlexaForBusiness
|
|
603
807
|
#
|
604
808
|
class DeleteAddressBookResponse < Aws::EmptyStructure; end
|
605
809
|
|
810
|
+
# @note When making an API call, you may pass DeleteConferenceProviderRequest
|
811
|
+
# data as a hash:
|
812
|
+
#
|
813
|
+
# {
|
814
|
+
# conference_provider_arn: "Arn", # required
|
815
|
+
# }
|
816
|
+
#
|
817
|
+
# @!attribute [rw] conference_provider_arn
|
818
|
+
# The ARN of the conference provider.
|
819
|
+
# @return [String]
|
820
|
+
#
|
821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteConferenceProviderRequest AWS API Documentation
|
822
|
+
#
|
823
|
+
class DeleteConferenceProviderRequest < Struct.new(
|
824
|
+
:conference_provider_arn)
|
825
|
+
include Aws::Structure
|
826
|
+
end
|
827
|
+
|
828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteConferenceProviderResponse AWS API Documentation
|
829
|
+
#
|
830
|
+
class DeleteConferenceProviderResponse < Aws::EmptyStructure; end
|
831
|
+
|
606
832
|
# @note When making an API call, you may pass DeleteContactRequest
|
607
833
|
# data as a hash:
|
608
834
|
#
|
@@ -625,6 +851,28 @@ module Aws::AlexaForBusiness
|
|
625
851
|
#
|
626
852
|
class DeleteContactResponse < Aws::EmptyStructure; end
|
627
853
|
|
854
|
+
# @note When making an API call, you may pass DeleteDeviceRequest
|
855
|
+
# data as a hash:
|
856
|
+
#
|
857
|
+
# {
|
858
|
+
# device_arn: "Arn", # required
|
859
|
+
# }
|
860
|
+
#
|
861
|
+
# @!attribute [rw] device_arn
|
862
|
+
# The ARN of the device for which to request details.
|
863
|
+
# @return [String]
|
864
|
+
#
|
865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteDeviceRequest AWS API Documentation
|
866
|
+
#
|
867
|
+
class DeleteDeviceRequest < Struct.new(
|
868
|
+
:device_arn)
|
869
|
+
include Aws::Structure
|
870
|
+
end
|
871
|
+
|
872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteDeviceResponse AWS API Documentation
|
873
|
+
#
|
874
|
+
class DeleteDeviceResponse < Aws::EmptyStructure; end
|
875
|
+
|
628
876
|
# @note When making an API call, you may pass DeleteProfileRequest
|
629
877
|
# data as a hash:
|
630
878
|
#
|
@@ -705,6 +953,34 @@ module Aws::AlexaForBusiness
|
|
705
953
|
#
|
706
954
|
class DeleteRoomSkillParameterResponse < Aws::EmptyStructure; end
|
707
955
|
|
956
|
+
# @note When making an API call, you may pass DeleteSkillAuthorizationRequest
|
957
|
+
# data as a hash:
|
958
|
+
#
|
959
|
+
# {
|
960
|
+
# skill_id: "SkillId", # required
|
961
|
+
# room_arn: "Arn",
|
962
|
+
# }
|
963
|
+
#
|
964
|
+
# @!attribute [rw] skill_id
|
965
|
+
# The unique identifier of a skill.
|
966
|
+
# @return [String]
|
967
|
+
#
|
968
|
+
# @!attribute [rw] room_arn
|
969
|
+
# The room that the skill is authorized for.
|
970
|
+
# @return [String]
|
971
|
+
#
|
972
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteSkillAuthorizationRequest AWS API Documentation
|
973
|
+
#
|
974
|
+
class DeleteSkillAuthorizationRequest < Struct.new(
|
975
|
+
:skill_id,
|
976
|
+
:room_arn)
|
977
|
+
include Aws::Structure
|
978
|
+
end
|
979
|
+
|
980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteSkillAuthorizationResponse AWS API Documentation
|
981
|
+
#
|
982
|
+
class DeleteSkillAuthorizationResponse < Aws::EmptyStructure; end
|
983
|
+
|
708
984
|
# @note When making an API call, you may pass DeleteSkillGroupRequest
|
709
985
|
# data as a hash:
|
710
986
|
#
|
@@ -755,6 +1031,34 @@ module Aws::AlexaForBusiness
|
|
755
1031
|
#
|
756
1032
|
class DeleteUserResponse < Aws::EmptyStructure; end
|
757
1033
|
|
1034
|
+
# The details about the developer that published the skill.
|
1035
|
+
#
|
1036
|
+
# @!attribute [rw] developer_name
|
1037
|
+
# The name of the developer.
|
1038
|
+
# @return [String]
|
1039
|
+
#
|
1040
|
+
# @!attribute [rw] privacy_policy
|
1041
|
+
# The URL of the privacy policy.
|
1042
|
+
# @return [String]
|
1043
|
+
#
|
1044
|
+
# @!attribute [rw] email
|
1045
|
+
# The email of the developer.
|
1046
|
+
# @return [String]
|
1047
|
+
#
|
1048
|
+
# @!attribute [rw] url
|
1049
|
+
# The website of the developer.
|
1050
|
+
# @return [String]
|
1051
|
+
#
|
1052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeveloperInfo AWS API Documentation
|
1053
|
+
#
|
1054
|
+
class DeveloperInfo < Struct.new(
|
1055
|
+
:developer_name,
|
1056
|
+
:privacy_policy,
|
1057
|
+
:email,
|
1058
|
+
:url)
|
1059
|
+
include Aws::Structure
|
1060
|
+
end
|
1061
|
+
|
758
1062
|
# A device with attributes.
|
759
1063
|
#
|
760
1064
|
# @!attribute [rw] device_arn
|
@@ -972,6 +1276,34 @@ module Aws::AlexaForBusiness
|
|
972
1276
|
#
|
973
1277
|
class DisassociateDeviceFromRoomResponse < Aws::EmptyStructure; end
|
974
1278
|
|
1279
|
+
# @note When making an API call, you may pass DisassociateSkillFromSkillGroupRequest
|
1280
|
+
# data as a hash:
|
1281
|
+
#
|
1282
|
+
# {
|
1283
|
+
# skill_group_arn: "Arn",
|
1284
|
+
# skill_id: "SkillId", # required
|
1285
|
+
# }
|
1286
|
+
#
|
1287
|
+
# @!attribute [rw] skill_group_arn
|
1288
|
+
# The unique identifier of a skill.
|
1289
|
+
# @return [String]
|
1290
|
+
#
|
1291
|
+
# @!attribute [rw] skill_id
|
1292
|
+
# The ARN of a skill group to associate to a skill.
|
1293
|
+
# @return [String]
|
1294
|
+
#
|
1295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateSkillFromSkillGroupRequest AWS API Documentation
|
1296
|
+
#
|
1297
|
+
class DisassociateSkillFromSkillGroupRequest < Struct.new(
|
1298
|
+
:skill_group_arn,
|
1299
|
+
:skill_id)
|
1300
|
+
include Aws::Structure
|
1301
|
+
end
|
1302
|
+
|
1303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateSkillFromSkillGroupResponse AWS API Documentation
|
1304
|
+
#
|
1305
|
+
class DisassociateSkillFromSkillGroupResponse < Aws::EmptyStructure; end
|
1306
|
+
|
975
1307
|
# @note When making an API call, you may pass DisassociateSkillGroupFromRoomRequest
|
976
1308
|
# data as a hash:
|
977
1309
|
#
|
@@ -1029,6 +1361,28 @@ module Aws::AlexaForBusiness
|
|
1029
1361
|
include Aws::Structure
|
1030
1362
|
end
|
1031
1363
|
|
1364
|
+
# @note When making an API call, you may pass ForgetSmartHomeAppliancesRequest
|
1365
|
+
# data as a hash:
|
1366
|
+
#
|
1367
|
+
# {
|
1368
|
+
# room_arn: "Arn", # required
|
1369
|
+
# }
|
1370
|
+
#
|
1371
|
+
# @!attribute [rw] room_arn
|
1372
|
+
# The room that the appliances are associated with.
|
1373
|
+
# @return [String]
|
1374
|
+
#
|
1375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ForgetSmartHomeAppliancesRequest AWS API Documentation
|
1376
|
+
#
|
1377
|
+
class ForgetSmartHomeAppliancesRequest < Struct.new(
|
1378
|
+
:room_arn)
|
1379
|
+
include Aws::Structure
|
1380
|
+
end
|
1381
|
+
|
1382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ForgetSmartHomeAppliancesResponse AWS API Documentation
|
1383
|
+
#
|
1384
|
+
class ForgetSmartHomeAppliancesResponse < Aws::EmptyStructure; end
|
1385
|
+
|
1032
1386
|
# @note When making an API call, you may pass GetAddressBookRequest
|
1033
1387
|
# data as a hash:
|
1034
1388
|
#
|
@@ -1058,6 +1412,52 @@ module Aws::AlexaForBusiness
|
|
1058
1412
|
include Aws::Structure
|
1059
1413
|
end
|
1060
1414
|
|
1415
|
+
# @api private
|
1416
|
+
#
|
1417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetConferencePreferenceRequest AWS API Documentation
|
1418
|
+
#
|
1419
|
+
class GetConferencePreferenceRequest < Aws::EmptyStructure; end
|
1420
|
+
|
1421
|
+
# @!attribute [rw] preference
|
1422
|
+
# The conference preference.
|
1423
|
+
# @return [Types::ConferencePreference]
|
1424
|
+
#
|
1425
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetConferencePreferenceResponse AWS API Documentation
|
1426
|
+
#
|
1427
|
+
class GetConferencePreferenceResponse < Struct.new(
|
1428
|
+
:preference)
|
1429
|
+
include Aws::Structure
|
1430
|
+
end
|
1431
|
+
|
1432
|
+
# @note When making an API call, you may pass GetConferenceProviderRequest
|
1433
|
+
# data as a hash:
|
1434
|
+
#
|
1435
|
+
# {
|
1436
|
+
# conference_provider_arn: "Arn", # required
|
1437
|
+
# }
|
1438
|
+
#
|
1439
|
+
# @!attribute [rw] conference_provider_arn
|
1440
|
+
# The ARN of the newly created conference provider.
|
1441
|
+
# @return [String]
|
1442
|
+
#
|
1443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetConferenceProviderRequest AWS API Documentation
|
1444
|
+
#
|
1445
|
+
class GetConferenceProviderRequest < Struct.new(
|
1446
|
+
:conference_provider_arn)
|
1447
|
+
include Aws::Structure
|
1448
|
+
end
|
1449
|
+
|
1450
|
+
# @!attribute [rw] conference_provider
|
1451
|
+
# The conference provider.
|
1452
|
+
# @return [Types::ConferenceProvider]
|
1453
|
+
#
|
1454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetConferenceProviderResponse AWS API Documentation
|
1455
|
+
#
|
1456
|
+
class GetConferenceProviderResponse < Struct.new(
|
1457
|
+
:conference_provider)
|
1458
|
+
include Aws::Structure
|
1459
|
+
end
|
1460
|
+
|
1061
1461
|
# @note When making an API call, you may pass GetContactRequest
|
1062
1462
|
# data as a hash:
|
1063
1463
|
#
|
@@ -1246,6 +1646,73 @@ module Aws::AlexaForBusiness
|
|
1246
1646
|
include Aws::Structure
|
1247
1647
|
end
|
1248
1648
|
|
1649
|
+
# The IP endpoint and protocol for calling.
|
1650
|
+
#
|
1651
|
+
# @note When making an API call, you may pass IPDialIn
|
1652
|
+
# data as a hash:
|
1653
|
+
#
|
1654
|
+
# {
|
1655
|
+
# endpoint: "Endpoint", # required
|
1656
|
+
# comms_protocol: "SIP", # required, accepts SIP, SIPS, H323
|
1657
|
+
# }
|
1658
|
+
#
|
1659
|
+
# @!attribute [rw] endpoint
|
1660
|
+
# The IP address.
|
1661
|
+
# @return [String]
|
1662
|
+
#
|
1663
|
+
# @!attribute [rw] comms_protocol
|
1664
|
+
# The protocol, including SIP, SIPS, and H323.
|
1665
|
+
# @return [String]
|
1666
|
+
#
|
1667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/IPDialIn AWS API Documentation
|
1668
|
+
#
|
1669
|
+
class IPDialIn < Struct.new(
|
1670
|
+
:endpoint,
|
1671
|
+
:comms_protocol)
|
1672
|
+
include Aws::Structure
|
1673
|
+
end
|
1674
|
+
|
1675
|
+
# @note When making an API call, you may pass ListConferenceProvidersRequest
|
1676
|
+
# data as a hash:
|
1677
|
+
#
|
1678
|
+
# {
|
1679
|
+
# next_token: "NextToken",
|
1680
|
+
# max_results: 1,
|
1681
|
+
# }
|
1682
|
+
#
|
1683
|
+
# @!attribute [rw] next_token
|
1684
|
+
# The tokens used for pagination.
|
1685
|
+
# @return [String]
|
1686
|
+
#
|
1687
|
+
# @!attribute [rw] max_results
|
1688
|
+
# The maximum number of conference providers to be return per
|
1689
|
+
# paginated calls.
|
1690
|
+
# @return [Integer]
|
1691
|
+
#
|
1692
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListConferenceProvidersRequest AWS API Documentation
|
1693
|
+
#
|
1694
|
+
class ListConferenceProvidersRequest < Struct.new(
|
1695
|
+
:next_token,
|
1696
|
+
:max_results)
|
1697
|
+
include Aws::Structure
|
1698
|
+
end
|
1699
|
+
|
1700
|
+
# @!attribute [rw] conference_providers
|
1701
|
+
# The conference providers.
|
1702
|
+
# @return [Array<Types::ConferenceProvider>]
|
1703
|
+
#
|
1704
|
+
# @!attribute [rw] next_token
|
1705
|
+
# The tokens used for pagination.
|
1706
|
+
# @return [String]
|
1707
|
+
#
|
1708
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListConferenceProvidersResponse AWS API Documentation
|
1709
|
+
#
|
1710
|
+
class ListConferenceProvidersResponse < Struct.new(
|
1711
|
+
:conference_providers,
|
1712
|
+
:next_token)
|
1713
|
+
include Aws::Structure
|
1714
|
+
end
|
1715
|
+
|
1249
1716
|
# @note When making an API call, you may pass ListDeviceEventsRequest
|
1250
1717
|
# data as a hash:
|
1251
1718
|
#
|
@@ -1313,6 +1780,8 @@ module Aws::AlexaForBusiness
|
|
1313
1780
|
#
|
1314
1781
|
# {
|
1315
1782
|
# skill_group_arn: "Arn",
|
1783
|
+
# enablement_type: "ENABLED", # accepts ENABLED, PENDING
|
1784
|
+
# skill_type: "PUBLIC", # accepts PUBLIC, PRIVATE, ALL
|
1316
1785
|
# next_token: "NextToken",
|
1317
1786
|
# max_results: 1,
|
1318
1787
|
# }
|
@@ -1322,6 +1791,15 @@ module Aws::AlexaForBusiness
|
|
1322
1791
|
# Required.
|
1323
1792
|
# @return [String]
|
1324
1793
|
#
|
1794
|
+
# @!attribute [rw] enablement_type
|
1795
|
+
# Whether the skill is enabled under the user's account, or if it
|
1796
|
+
# requires linking to be used.
|
1797
|
+
# @return [String]
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] skill_type
|
1800
|
+
# Whether the skill is publicly available or is a private skill.
|
1801
|
+
# @return [String]
|
1802
|
+
#
|
1325
1803
|
# @!attribute [rw] next_token
|
1326
1804
|
# An optional token returned from a prior request. Use this token for
|
1327
1805
|
# pagination of results from this action. If this parameter is
|
@@ -1330,33 +1808,168 @@ module Aws::AlexaForBusiness
|
|
1330
1808
|
# @return [String]
|
1331
1809
|
#
|
1332
1810
|
# @!attribute [rw] max_results
|
1333
|
-
# The maximum number of results to include in the response. If more
|
1334
|
-
# results exist than the specified `MaxResults` value, a token is
|
1335
|
-
# included in the response so that the remaining results can be
|
1336
|
-
# retrieved. Required.
|
1811
|
+
# The maximum number of results to include in the response. If more
|
1812
|
+
# results exist than the specified `MaxResults` value, a token is
|
1813
|
+
# included in the response so that the remaining results can be
|
1814
|
+
# retrieved. Required.
|
1815
|
+
# @return [Integer]
|
1816
|
+
#
|
1817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSkillsRequest AWS API Documentation
|
1818
|
+
#
|
1819
|
+
class ListSkillsRequest < Struct.new(
|
1820
|
+
:skill_group_arn,
|
1821
|
+
:enablement_type,
|
1822
|
+
:skill_type,
|
1823
|
+
:next_token,
|
1824
|
+
:max_results)
|
1825
|
+
include Aws::Structure
|
1826
|
+
end
|
1827
|
+
|
1828
|
+
# @!attribute [rw] skill_summaries
|
1829
|
+
# The list of enabled skills requested. Required.
|
1830
|
+
# @return [Array<Types::SkillSummary>]
|
1831
|
+
#
|
1832
|
+
# @!attribute [rw] next_token
|
1833
|
+
# The token returned to indicate that there is more data available.
|
1834
|
+
# @return [String]
|
1835
|
+
#
|
1836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSkillsResponse AWS API Documentation
|
1837
|
+
#
|
1838
|
+
class ListSkillsResponse < Struct.new(
|
1839
|
+
:skill_summaries,
|
1840
|
+
:next_token)
|
1841
|
+
include Aws::Structure
|
1842
|
+
end
|
1843
|
+
|
1844
|
+
# @note When making an API call, you may pass ListSkillsStoreCategoriesRequest
|
1845
|
+
# data as a hash:
|
1846
|
+
#
|
1847
|
+
# {
|
1848
|
+
# next_token: "NextToken",
|
1849
|
+
# max_results: 1,
|
1850
|
+
# }
|
1851
|
+
#
|
1852
|
+
# @!attribute [rw] next_token
|
1853
|
+
# The tokens used for pagination.
|
1854
|
+
# @return [String]
|
1855
|
+
#
|
1856
|
+
# @!attribute [rw] max_results
|
1857
|
+
# The maximum number of categories returned per paginated calls.
|
1858
|
+
# @return [Integer]
|
1859
|
+
#
|
1860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSkillsStoreCategoriesRequest AWS API Documentation
|
1861
|
+
#
|
1862
|
+
class ListSkillsStoreCategoriesRequest < Struct.new(
|
1863
|
+
:next_token,
|
1864
|
+
:max_results)
|
1865
|
+
include Aws::Structure
|
1866
|
+
end
|
1867
|
+
|
1868
|
+
# @!attribute [rw] category_list
|
1869
|
+
# The list of categories.
|
1870
|
+
# @return [Array<Types::Category>]
|
1871
|
+
#
|
1872
|
+
# @!attribute [rw] next_token
|
1873
|
+
# The tokens used for pagination.
|
1874
|
+
# @return [String]
|
1875
|
+
#
|
1876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSkillsStoreCategoriesResponse AWS API Documentation
|
1877
|
+
#
|
1878
|
+
class ListSkillsStoreCategoriesResponse < Struct.new(
|
1879
|
+
:category_list,
|
1880
|
+
:next_token)
|
1881
|
+
include Aws::Structure
|
1882
|
+
end
|
1883
|
+
|
1884
|
+
# @note When making an API call, you may pass ListSkillsStoreSkillsByCategoryRequest
|
1885
|
+
# data as a hash:
|
1886
|
+
#
|
1887
|
+
# {
|
1888
|
+
# category_id: 1, # required
|
1889
|
+
# next_token: "NextToken",
|
1890
|
+
# max_results: 1,
|
1891
|
+
# }
|
1892
|
+
#
|
1893
|
+
# @!attribute [rw] category_id
|
1894
|
+
# The category ID for which the skills are being retrieved from the
|
1895
|
+
# skill store.
|
1896
|
+
# @return [Integer]
|
1897
|
+
#
|
1898
|
+
# @!attribute [rw] next_token
|
1899
|
+
# The tokens used for pagination.
|
1900
|
+
# @return [String]
|
1901
|
+
#
|
1902
|
+
# @!attribute [rw] max_results
|
1903
|
+
# The maximum number of skills returned per paginated calls.
|
1904
|
+
# @return [Integer]
|
1905
|
+
#
|
1906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSkillsStoreSkillsByCategoryRequest AWS API Documentation
|
1907
|
+
#
|
1908
|
+
class ListSkillsStoreSkillsByCategoryRequest < Struct.new(
|
1909
|
+
:category_id,
|
1910
|
+
:next_token,
|
1911
|
+
:max_results)
|
1912
|
+
include Aws::Structure
|
1913
|
+
end
|
1914
|
+
|
1915
|
+
# @!attribute [rw] skills_store_skills
|
1916
|
+
# The skill store skills.
|
1917
|
+
# @return [Array<Types::SkillsStoreSkill>]
|
1918
|
+
#
|
1919
|
+
# @!attribute [rw] next_token
|
1920
|
+
# The tokens used for pagination.
|
1921
|
+
# @return [String]
|
1922
|
+
#
|
1923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSkillsStoreSkillsByCategoryResponse AWS API Documentation
|
1924
|
+
#
|
1925
|
+
class ListSkillsStoreSkillsByCategoryResponse < Struct.new(
|
1926
|
+
:skills_store_skills,
|
1927
|
+
:next_token)
|
1928
|
+
include Aws::Structure
|
1929
|
+
end
|
1930
|
+
|
1931
|
+
# @note When making an API call, you may pass ListSmartHomeAppliancesRequest
|
1932
|
+
# data as a hash:
|
1933
|
+
#
|
1934
|
+
# {
|
1935
|
+
# room_arn: "Arn", # required
|
1936
|
+
# max_results: 1,
|
1937
|
+
# next_token: "NextToken",
|
1938
|
+
# }
|
1939
|
+
#
|
1940
|
+
# @!attribute [rw] room_arn
|
1941
|
+
# The room that the appliances are associated with.
|
1942
|
+
# @return [String]
|
1943
|
+
#
|
1944
|
+
# @!attribute [rw] max_results
|
1945
|
+
# The maximum number of appliances to be return per paginated calls.
|
1337
1946
|
# @return [Integer]
|
1338
1947
|
#
|
1339
|
-
#
|
1948
|
+
# @!attribute [rw] next_token
|
1949
|
+
# The tokens used for pagination.
|
1950
|
+
# @return [String]
|
1340
1951
|
#
|
1341
|
-
|
1342
|
-
|
1343
|
-
|
1344
|
-
:
|
1952
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSmartHomeAppliancesRequest AWS API Documentation
|
1953
|
+
#
|
1954
|
+
class ListSmartHomeAppliancesRequest < Struct.new(
|
1955
|
+
:room_arn,
|
1956
|
+
:max_results,
|
1957
|
+
:next_token)
|
1345
1958
|
include Aws::Structure
|
1346
1959
|
end
|
1347
1960
|
|
1348
|
-
# @!attribute [rw]
|
1349
|
-
# The
|
1350
|
-
# @return [Array<Types::
|
1961
|
+
# @!attribute [rw] smart_home_appliances
|
1962
|
+
# The smart home appliances.
|
1963
|
+
# @return [Array<Types::SmartHomeAppliance>]
|
1351
1964
|
#
|
1352
1965
|
# @!attribute [rw] next_token
|
1353
|
-
# The
|
1966
|
+
# The tokens used for pagination.
|
1354
1967
|
# @return [String]
|
1355
1968
|
#
|
1356
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/
|
1969
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSmartHomeAppliancesResponse AWS API Documentation
|
1357
1970
|
#
|
1358
|
-
class
|
1359
|
-
:
|
1971
|
+
class ListSmartHomeAppliancesResponse < Struct.new(
|
1972
|
+
:smart_home_appliances,
|
1360
1973
|
:next_token)
|
1361
1974
|
include Aws::Structure
|
1362
1975
|
end
|
@@ -1413,6 +2026,79 @@ module Aws::AlexaForBusiness
|
|
1413
2026
|
include Aws::Structure
|
1414
2027
|
end
|
1415
2028
|
|
2029
|
+
# The values that indicate whether a pin is always required (YES), never
|
2030
|
+
# required (NO), or OPTIONAL.
|
2031
|
+
#
|
2032
|
+
# * If YES, Alexa will always ask for a meeting pin.
|
2033
|
+
#
|
2034
|
+
# * If NO, Alexa will never ask for a meeting pin.
|
2035
|
+
#
|
2036
|
+
# * If OPTIONAL, Alexa will ask if you have a meeting pin and if the
|
2037
|
+
# customer responds with yes, it will ask for the meeting pin.
|
2038
|
+
#
|
2039
|
+
# @note When making an API call, you may pass MeetingSetting
|
2040
|
+
# data as a hash:
|
2041
|
+
#
|
2042
|
+
# {
|
2043
|
+
# require_pin: "YES", # required, accepts YES, NO, OPTIONAL
|
2044
|
+
# }
|
2045
|
+
#
|
2046
|
+
# @!attribute [rw] require_pin
|
2047
|
+
# The values that indicate whether the pin is always required.
|
2048
|
+
# @return [String]
|
2049
|
+
#
|
2050
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/MeetingSetting AWS API Documentation
|
2051
|
+
#
|
2052
|
+
class MeetingSetting < Struct.new(
|
2053
|
+
:require_pin)
|
2054
|
+
include Aws::Structure
|
2055
|
+
end
|
2056
|
+
|
2057
|
+
# The information for public switched telephone network (PSTN)
|
2058
|
+
# conferencing.
|
2059
|
+
#
|
2060
|
+
# @note When making an API call, you may pass PSTNDialIn
|
2061
|
+
# data as a hash:
|
2062
|
+
#
|
2063
|
+
# {
|
2064
|
+
# country_code: "CountryCode", # required
|
2065
|
+
# phone_number: "PhoneNumber", # required
|
2066
|
+
# one_click_id_delay: "OneClickIdDelay", # required
|
2067
|
+
# one_click_pin_delay: "OneClickPinDelay", # required
|
2068
|
+
# }
|
2069
|
+
#
|
2070
|
+
# @!attribute [rw] country_code
|
2071
|
+
# The zip code.
|
2072
|
+
# @return [String]
|
2073
|
+
#
|
2074
|
+
# @!attribute [rw] phone_number
|
2075
|
+
# The phone number to call to join the conference.
|
2076
|
+
# @return [String]
|
2077
|
+
#
|
2078
|
+
# @!attribute [rw] one_click_id_delay
|
2079
|
+
# The delay duration before Alexa enters the conference ID with
|
2080
|
+
# dual-tone multi-frequency (DTMF). Each number on the dial pad
|
2081
|
+
# corresponds to a DTMF tone, which is how we send data over the
|
2082
|
+
# telephone network.
|
2083
|
+
# @return [String]
|
2084
|
+
#
|
2085
|
+
# @!attribute [rw] one_click_pin_delay
|
2086
|
+
# The delay duration before Alexa enters the conference pin with
|
2087
|
+
# dual-tone multi-frequency (DTMF). Each number on the dial pad
|
2088
|
+
# corresponds to a DTMF tone, which is how we send data over the
|
2089
|
+
# telephone network.
|
2090
|
+
# @return [String]
|
2091
|
+
#
|
2092
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/PSTNDialIn AWS API Documentation
|
2093
|
+
#
|
2094
|
+
class PSTNDialIn < Struct.new(
|
2095
|
+
:country_code,
|
2096
|
+
:phone_number,
|
2097
|
+
:one_click_id_delay,
|
2098
|
+
:one_click_pin_delay)
|
2099
|
+
include Aws::Structure
|
2100
|
+
end
|
2101
|
+
|
1416
2102
|
# A room profile with attributes.
|
1417
2103
|
#
|
1418
2104
|
# @!attribute [rw] profile_arn
|
@@ -1423,6 +2109,10 @@ module Aws::AlexaForBusiness
|
|
1423
2109
|
# The name of a room profile.
|
1424
2110
|
# @return [String]
|
1425
2111
|
#
|
2112
|
+
# @!attribute [rw] is_default
|
2113
|
+
# Retrieves if the profile is default or not.
|
2114
|
+
# @return [Boolean]
|
2115
|
+
#
|
1426
2116
|
# @!attribute [rw] address
|
1427
2117
|
# The address of a room profile.
|
1428
2118
|
# @return [String]
|
@@ -1455,11 +2145,16 @@ module Aws::AlexaForBusiness
|
|
1455
2145
|
# The PSTN setting of a room profile.
|
1456
2146
|
# @return [Boolean]
|
1457
2147
|
#
|
2148
|
+
# @!attribute [rw] address_book_arn
|
2149
|
+
# The ARN of the address book.
|
2150
|
+
# @return [String]
|
2151
|
+
#
|
1458
2152
|
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Profile AWS API Documentation
|
1459
2153
|
#
|
1460
2154
|
class Profile < Struct.new(
|
1461
2155
|
:profile_arn,
|
1462
2156
|
:profile_name,
|
2157
|
+
:is_default,
|
1463
2158
|
:address,
|
1464
2159
|
:timezone,
|
1465
2160
|
:distance_unit,
|
@@ -1467,7 +2162,8 @@ module Aws::AlexaForBusiness
|
|
1467
2162
|
:wake_word,
|
1468
2163
|
:setup_mode_disabled,
|
1469
2164
|
:max_volume_limit,
|
1470
|
-
:pstn_enabled
|
2165
|
+
:pstn_enabled,
|
2166
|
+
:address_book_arn)
|
1471
2167
|
include Aws::Structure
|
1472
2168
|
end
|
1473
2169
|
|
@@ -1481,6 +2177,10 @@ module Aws::AlexaForBusiness
|
|
1481
2177
|
# The name of a room profile.
|
1482
2178
|
# @return [String]
|
1483
2179
|
#
|
2180
|
+
# @!attribute [rw] is_default
|
2181
|
+
# Retrieves if the profile data is default or not.
|
2182
|
+
# @return [Boolean]
|
2183
|
+
#
|
1484
2184
|
# @!attribute [rw] address
|
1485
2185
|
# The address of a room profile.
|
1486
2186
|
# @return [String]
|
@@ -1506,6 +2206,7 @@ module Aws::AlexaForBusiness
|
|
1506
2206
|
class ProfileData < Struct.new(
|
1507
2207
|
:profile_arn,
|
1508
2208
|
:profile_name,
|
2209
|
+
:is_default,
|
1509
2210
|
:address,
|
1510
2211
|
:timezone,
|
1511
2212
|
:distance_unit,
|
@@ -1514,6 +2215,30 @@ module Aws::AlexaForBusiness
|
|
1514
2215
|
include Aws::Structure
|
1515
2216
|
end
|
1516
2217
|
|
2218
|
+
# @note When making an API call, you may pass PutConferencePreferenceRequest
|
2219
|
+
# data as a hash:
|
2220
|
+
#
|
2221
|
+
# {
|
2222
|
+
# conference_preference: { # required
|
2223
|
+
# default_conference_provider_arn: "Arn",
|
2224
|
+
# },
|
2225
|
+
# }
|
2226
|
+
#
|
2227
|
+
# @!attribute [rw] conference_preference
|
2228
|
+
# The conference preference of a specific conference provider.
|
2229
|
+
# @return [Types::ConferencePreference]
|
2230
|
+
#
|
2231
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/PutConferencePreferenceRequest AWS API Documentation
|
2232
|
+
#
|
2233
|
+
class PutConferencePreferenceRequest < Struct.new(
|
2234
|
+
:conference_preference)
|
2235
|
+
include Aws::Structure
|
2236
|
+
end
|
2237
|
+
|
2238
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/PutConferencePreferenceResponse AWS API Documentation
|
2239
|
+
#
|
2240
|
+
class PutConferencePreferenceResponse < Aws::EmptyStructure; end
|
2241
|
+
|
1517
2242
|
# @note When making an API call, you may pass PutRoomSkillParameterRequest
|
1518
2243
|
# data as a hash:
|
1519
2244
|
#
|
@@ -1553,6 +2278,125 @@ module Aws::AlexaForBusiness
|
|
1553
2278
|
#
|
1554
2279
|
class PutRoomSkillParameterResponse < Aws::EmptyStructure; end
|
1555
2280
|
|
2281
|
+
# @note When making an API call, you may pass PutSkillAuthorizationRequest
|
2282
|
+
# data as a hash:
|
2283
|
+
#
|
2284
|
+
# {
|
2285
|
+
# authorization_result: { # required
|
2286
|
+
# "Key" => "Value",
|
2287
|
+
# },
|
2288
|
+
# skill_id: "SkillId", # required
|
2289
|
+
# room_arn: "Arn",
|
2290
|
+
# }
|
2291
|
+
#
|
2292
|
+
# @!attribute [rw] authorization_result
|
2293
|
+
# The authorization result specific to OAUTH code grant output.
|
2294
|
+
# "Code” must be populated in the AuthorizationResult map to
|
2295
|
+
# establish the authorization.
|
2296
|
+
# @return [Hash<String,String>]
|
2297
|
+
#
|
2298
|
+
# @!attribute [rw] skill_id
|
2299
|
+
# The unique identifier of a skill.
|
2300
|
+
# @return [String]
|
2301
|
+
#
|
2302
|
+
# @!attribute [rw] room_arn
|
2303
|
+
# The room that the skill is authorized for.
|
2304
|
+
# @return [String]
|
2305
|
+
#
|
2306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/PutSkillAuthorizationRequest AWS API Documentation
|
2307
|
+
#
|
2308
|
+
class PutSkillAuthorizationRequest < Struct.new(
|
2309
|
+
:authorization_result,
|
2310
|
+
:skill_id,
|
2311
|
+
:room_arn)
|
2312
|
+
include Aws::Structure
|
2313
|
+
end
|
2314
|
+
|
2315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/PutSkillAuthorizationResponse AWS API Documentation
|
2316
|
+
#
|
2317
|
+
class PutSkillAuthorizationResponse < Aws::EmptyStructure; end
|
2318
|
+
|
2319
|
+
# @note When making an API call, you may pass RegisterAVSDeviceRequest
|
2320
|
+
# data as a hash:
|
2321
|
+
#
|
2322
|
+
# {
|
2323
|
+
# client_id: "ClientId", # required
|
2324
|
+
# user_code: "UserCode", # required
|
2325
|
+
# product_id: "ProductId", # required
|
2326
|
+
# device_serial_number: "DeviceSerialNumberForAVS", # required
|
2327
|
+
# amazon_id: "AmazonId", # required
|
2328
|
+
# }
|
2329
|
+
#
|
2330
|
+
# @!attribute [rw] client_id
|
2331
|
+
# The client ID of the OEM used for code-based linking authorization
|
2332
|
+
# on an AVS device.
|
2333
|
+
# @return [String]
|
2334
|
+
#
|
2335
|
+
# @!attribute [rw] user_code
|
2336
|
+
# The code that is obtained after your AVS device has made a POST
|
2337
|
+
# request to LWA as a part of the Device Authorization Request
|
2338
|
+
# component of the OAuth code-based linking specification.
|
2339
|
+
# @return [String]
|
2340
|
+
#
|
2341
|
+
# @!attribute [rw] product_id
|
2342
|
+
# The product ID used to identify your AVS device during
|
2343
|
+
# authorization.
|
2344
|
+
# @return [String]
|
2345
|
+
#
|
2346
|
+
# @!attribute [rw] device_serial_number
|
2347
|
+
# The key generated by the OEM that uniquely identifies a specified
|
2348
|
+
# instance of your AVS device.
|
2349
|
+
# @return [String]
|
2350
|
+
#
|
2351
|
+
# @!attribute [rw] amazon_id
|
2352
|
+
# The device type ID for your AVS device generated by Amazon when the
|
2353
|
+
# OEM creates a new product on Amazon's Developer Console.
|
2354
|
+
# @return [String]
|
2355
|
+
#
|
2356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RegisterAVSDeviceRequest AWS API Documentation
|
2357
|
+
#
|
2358
|
+
class RegisterAVSDeviceRequest < Struct.new(
|
2359
|
+
:client_id,
|
2360
|
+
:user_code,
|
2361
|
+
:product_id,
|
2362
|
+
:device_serial_number,
|
2363
|
+
:amazon_id)
|
2364
|
+
include Aws::Structure
|
2365
|
+
end
|
2366
|
+
|
2367
|
+
# @!attribute [rw] device_arn
|
2368
|
+
# The ARN of the device.
|
2369
|
+
# @return [String]
|
2370
|
+
#
|
2371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RegisterAVSDeviceResponse AWS API Documentation
|
2372
|
+
#
|
2373
|
+
class RegisterAVSDeviceResponse < Struct.new(
|
2374
|
+
:device_arn)
|
2375
|
+
include Aws::Structure
|
2376
|
+
end
|
2377
|
+
|
2378
|
+
# @note When making an API call, you may pass RejectSkillRequest
|
2379
|
+
# data as a hash:
|
2380
|
+
#
|
2381
|
+
# {
|
2382
|
+
# skill_id: "SkillId", # required
|
2383
|
+
# }
|
2384
|
+
#
|
2385
|
+
# @!attribute [rw] skill_id
|
2386
|
+
# The unique identifier of the skill.
|
2387
|
+
# @return [String]
|
2388
|
+
#
|
2389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RejectSkillRequest AWS API Documentation
|
2390
|
+
#
|
2391
|
+
class RejectSkillRequest < Struct.new(
|
2392
|
+
:skill_id)
|
2393
|
+
include Aws::Structure
|
2394
|
+
end
|
2395
|
+
|
2396
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RejectSkillResponse AWS API Documentation
|
2397
|
+
#
|
2398
|
+
class RejectSkillResponse < Aws::EmptyStructure; end
|
2399
|
+
|
1556
2400
|
# @note When making an API call, you may pass ResolveRoomRequest
|
1557
2401
|
# data as a hash:
|
1558
2402
|
#
|
@@ -2285,6 +3129,66 @@ module Aws::AlexaForBusiness
|
|
2285
3129
|
#
|
2286
3130
|
class SendInvitationResponse < Aws::EmptyStructure; end
|
2287
3131
|
|
3132
|
+
# Granular information about the skill.
|
3133
|
+
#
|
3134
|
+
# @!attribute [rw] product_description
|
3135
|
+
# The description of the product.
|
3136
|
+
# @return [String]
|
3137
|
+
#
|
3138
|
+
# @!attribute [rw] invocation_phrase
|
3139
|
+
# The phrase used to trigger the skill.
|
3140
|
+
# @return [String]
|
3141
|
+
#
|
3142
|
+
# @!attribute [rw] release_date
|
3143
|
+
# The date when the skill was released.
|
3144
|
+
# @return [String]
|
3145
|
+
#
|
3146
|
+
# @!attribute [rw] end_user_license_agreement
|
3147
|
+
# The URL of the end user license agreement.
|
3148
|
+
# @return [String]
|
3149
|
+
#
|
3150
|
+
# @!attribute [rw] generic_keywords
|
3151
|
+
# The generic keywords associated with the skill that can be used to
|
3152
|
+
# find a skill.
|
3153
|
+
# @return [Array<String>]
|
3154
|
+
#
|
3155
|
+
# @!attribute [rw] bullet_points
|
3156
|
+
# The details about what the skill supports organized as bullet
|
3157
|
+
# points.
|
3158
|
+
# @return [Array<String>]
|
3159
|
+
#
|
3160
|
+
# @!attribute [rw] new_in_this_version_bullet_points
|
3161
|
+
# The updates added in bullet points.
|
3162
|
+
# @return [Array<String>]
|
3163
|
+
#
|
3164
|
+
# @!attribute [rw] skill_types
|
3165
|
+
# The types of skills.
|
3166
|
+
# @return [Array<String>]
|
3167
|
+
#
|
3168
|
+
# @!attribute [rw] reviews
|
3169
|
+
# The list of reviews for the skill, including Key and Value pair.
|
3170
|
+
# @return [Hash<String,String>]
|
3171
|
+
#
|
3172
|
+
# @!attribute [rw] developer_info
|
3173
|
+
# The details about the developer that published the skill.
|
3174
|
+
# @return [Types::DeveloperInfo]
|
3175
|
+
#
|
3176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SkillDetails AWS API Documentation
|
3177
|
+
#
|
3178
|
+
class SkillDetails < Struct.new(
|
3179
|
+
:product_description,
|
3180
|
+
:invocation_phrase,
|
3181
|
+
:release_date,
|
3182
|
+
:end_user_license_agreement,
|
3183
|
+
:generic_keywords,
|
3184
|
+
:bullet_points,
|
3185
|
+
:new_in_this_version_bullet_points,
|
3186
|
+
:skill_types,
|
3187
|
+
:reviews,
|
3188
|
+
:developer_info)
|
3189
|
+
include Aws::Structure
|
3190
|
+
end
|
3191
|
+
|
2288
3192
|
# A skill group with attributes.
|
2289
3193
|
#
|
2290
3194
|
# @!attribute [rw] skill_group_arn
|
@@ -2345,15 +3249,93 @@ module Aws::AlexaForBusiness
|
|
2345
3249
|
# Linking support for a skill.
|
2346
3250
|
# @return [Boolean]
|
2347
3251
|
#
|
3252
|
+
# @!attribute [rw] enablement_type
|
3253
|
+
# Whether the skill is enabled under the user's account, or if it
|
3254
|
+
# requires linking to be used.
|
3255
|
+
# @return [String]
|
3256
|
+
#
|
3257
|
+
# @!attribute [rw] skill_type
|
3258
|
+
# Whether the skill is publicly available or is a private skill.
|
3259
|
+
# @return [String]
|
3260
|
+
#
|
2348
3261
|
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SkillSummary AWS API Documentation
|
2349
3262
|
#
|
2350
3263
|
class SkillSummary < Struct.new(
|
2351
3264
|
:skill_id,
|
2352
3265
|
:skill_name,
|
3266
|
+
:supports_linking,
|
3267
|
+
:enablement_type,
|
3268
|
+
:skill_type)
|
3269
|
+
include Aws::Structure
|
3270
|
+
end
|
3271
|
+
|
3272
|
+
# The detailed information about an Alexa skill.
|
3273
|
+
#
|
3274
|
+
# @!attribute [rw] skill_id
|
3275
|
+
# The ARN of the skill.
|
3276
|
+
# @return [String]
|
3277
|
+
#
|
3278
|
+
# @!attribute [rw] skill_name
|
3279
|
+
# The name of the skill.
|
3280
|
+
# @return [String]
|
3281
|
+
#
|
3282
|
+
# @!attribute [rw] short_description
|
3283
|
+
# Short description about the skill.
|
3284
|
+
# @return [String]
|
3285
|
+
#
|
3286
|
+
# @!attribute [rw] icon_url
|
3287
|
+
# The URL where the skill icon resides.
|
3288
|
+
# @return [String]
|
3289
|
+
#
|
3290
|
+
# @!attribute [rw] sample_utterances
|
3291
|
+
# Sample utterances that interact with the skill.
|
3292
|
+
# @return [Array<String>]
|
3293
|
+
#
|
3294
|
+
# @!attribute [rw] skill_details
|
3295
|
+
# Information about the skill.
|
3296
|
+
# @return [Types::SkillDetails]
|
3297
|
+
#
|
3298
|
+
# @!attribute [rw] supports_linking
|
3299
|
+
# Linking support for a skill.
|
3300
|
+
# @return [Boolean]
|
3301
|
+
#
|
3302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SkillsStoreSkill AWS API Documentation
|
3303
|
+
#
|
3304
|
+
class SkillsStoreSkill < Struct.new(
|
3305
|
+
:skill_id,
|
3306
|
+
:skill_name,
|
3307
|
+
:short_description,
|
3308
|
+
:icon_url,
|
3309
|
+
:sample_utterances,
|
3310
|
+
:skill_details,
|
2353
3311
|
:supports_linking)
|
2354
3312
|
include Aws::Structure
|
2355
3313
|
end
|
2356
3314
|
|
3315
|
+
# A smart home appliance that can connect to a central system. Any
|
3316
|
+
# domestic device can be a smart appliance.
|
3317
|
+
#
|
3318
|
+
# @!attribute [rw] friendly_name
|
3319
|
+
# The friendly name of the smart home appliance.
|
3320
|
+
# @return [String]
|
3321
|
+
#
|
3322
|
+
# @!attribute [rw] description
|
3323
|
+
# The description of the smart home appliance.
|
3324
|
+
# @return [String]
|
3325
|
+
#
|
3326
|
+
# @!attribute [rw] manufacturer_name
|
3327
|
+
# The name of the manufacturer of the smart home appliance.
|
3328
|
+
# @return [String]
|
3329
|
+
#
|
3330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SmartHomeAppliance AWS API Documentation
|
3331
|
+
#
|
3332
|
+
class SmartHomeAppliance < Struct.new(
|
3333
|
+
:friendly_name,
|
3334
|
+
:description,
|
3335
|
+
:manufacturer_name)
|
3336
|
+
include Aws::Structure
|
3337
|
+
end
|
3338
|
+
|
2357
3339
|
# An object representing a sort criteria.
|
2358
3340
|
#
|
2359
3341
|
# @note When making an API call, you may pass Sort
|
@@ -2415,14 +3397,36 @@ module Aws::AlexaForBusiness
|
|
2415
3397
|
#
|
2416
3398
|
class StartDeviceSyncResponse < Aws::EmptyStructure; end
|
2417
3399
|
|
3400
|
+
# @note When making an API call, you may pass StartSmartHomeApplianceDiscoveryRequest
|
3401
|
+
# data as a hash:
|
3402
|
+
#
|
3403
|
+
# {
|
3404
|
+
# room_arn: "Arn", # required
|
3405
|
+
# }
|
3406
|
+
#
|
3407
|
+
# @!attribute [rw] room_arn
|
3408
|
+
# The room where smart home appliance discovery was initiated.
|
3409
|
+
# @return [String]
|
3410
|
+
#
|
3411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/StartSmartHomeApplianceDiscoveryRequest AWS API Documentation
|
3412
|
+
#
|
3413
|
+
class StartSmartHomeApplianceDiscoveryRequest < Struct.new(
|
3414
|
+
:room_arn)
|
3415
|
+
include Aws::Structure
|
3416
|
+
end
|
3417
|
+
|
3418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/StartSmartHomeApplianceDiscoveryResponse AWS API Documentation
|
3419
|
+
#
|
3420
|
+
class StartSmartHomeApplianceDiscoveryResponse < Aws::EmptyStructure; end
|
3421
|
+
|
2418
3422
|
# A key-value pair that can be associated with a resource.
|
2419
3423
|
#
|
2420
3424
|
# @note When making an API call, you may pass Tag
|
2421
3425
|
# data as a hash:
|
2422
3426
|
#
|
2423
3427
|
# {
|
2424
|
-
# key: "TagKey",
|
2425
|
-
# value: "TagValue",
|
3428
|
+
# key: "TagKey", # required
|
3429
|
+
# value: "TagValue", # required
|
2426
3430
|
# }
|
2427
3431
|
#
|
2428
3432
|
# @!attribute [rw] key
|
@@ -2448,8 +3452,8 @@ module Aws::AlexaForBusiness
|
|
2448
3452
|
# arn: "Arn", # required
|
2449
3453
|
# tags: [ # required
|
2450
3454
|
# {
|
2451
|
-
# key: "TagKey",
|
2452
|
-
# value: "TagValue",
|
3455
|
+
# key: "TagKey", # required
|
3456
|
+
# value: "TagValue", # required
|
2453
3457
|
# },
|
2454
3458
|
# ],
|
2455
3459
|
# }
|
@@ -2539,6 +3543,62 @@ module Aws::AlexaForBusiness
|
|
2539
3543
|
#
|
2540
3544
|
class UpdateAddressBookResponse < Aws::EmptyStructure; end
|
2541
3545
|
|
3546
|
+
# @note When making an API call, you may pass UpdateConferenceProviderRequest
|
3547
|
+
# data as a hash:
|
3548
|
+
#
|
3549
|
+
# {
|
3550
|
+
# conference_provider_arn: "Arn", # required
|
3551
|
+
# conference_provider_type: "CHIME", # required, accepts CHIME, BLUEJEANS, FUZE, GOOGLE_HANGOUTS, POLYCOM, RINGCENTRAL, SKYPE_FOR_BUSINESS, WEBEX, ZOOM, CUSTOM
|
3552
|
+
# ip_dial_in: {
|
3553
|
+
# endpoint: "Endpoint", # required
|
3554
|
+
# comms_protocol: "SIP", # required, accepts SIP, SIPS, H323
|
3555
|
+
# },
|
3556
|
+
# pstn_dial_in: {
|
3557
|
+
# country_code: "CountryCode", # required
|
3558
|
+
# phone_number: "PhoneNumber", # required
|
3559
|
+
# one_click_id_delay: "OneClickIdDelay", # required
|
3560
|
+
# one_click_pin_delay: "OneClickPinDelay", # required
|
3561
|
+
# },
|
3562
|
+
# meeting_setting: { # required
|
3563
|
+
# require_pin: "YES", # required, accepts YES, NO, OPTIONAL
|
3564
|
+
# },
|
3565
|
+
# }
|
3566
|
+
#
|
3567
|
+
# @!attribute [rw] conference_provider_arn
|
3568
|
+
# The ARN of the conference provider.
|
3569
|
+
# @return [String]
|
3570
|
+
#
|
3571
|
+
# @!attribute [rw] conference_provider_type
|
3572
|
+
# The type of the conference provider.
|
3573
|
+
# @return [String]
|
3574
|
+
#
|
3575
|
+
# @!attribute [rw] ip_dial_in
|
3576
|
+
# The IP endpoint and protocol for calling.
|
3577
|
+
# @return [Types::IPDialIn]
|
3578
|
+
#
|
3579
|
+
# @!attribute [rw] pstn_dial_in
|
3580
|
+
# The information for PSTN conferencing.
|
3581
|
+
# @return [Types::PSTNDialIn]
|
3582
|
+
#
|
3583
|
+
# @!attribute [rw] meeting_setting
|
3584
|
+
# The meeting settings for the conference provider.
|
3585
|
+
# @return [Types::MeetingSetting]
|
3586
|
+
#
|
3587
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateConferenceProviderRequest AWS API Documentation
|
3588
|
+
#
|
3589
|
+
class UpdateConferenceProviderRequest < Struct.new(
|
3590
|
+
:conference_provider_arn,
|
3591
|
+
:conference_provider_type,
|
3592
|
+
:ip_dial_in,
|
3593
|
+
:pstn_dial_in,
|
3594
|
+
:meeting_setting)
|
3595
|
+
include Aws::Structure
|
3596
|
+
end
|
3597
|
+
|
3598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateConferenceProviderResponse AWS API Documentation
|
3599
|
+
#
|
3600
|
+
class UpdateConferenceProviderResponse < Aws::EmptyStructure; end
|
3601
|
+
|
2542
3602
|
# @note When making an API call, you may pass UpdateContactRequest
|
2543
3603
|
# data as a hash:
|
2544
3604
|
#
|
@@ -2619,6 +3679,7 @@ module Aws::AlexaForBusiness
|
|
2619
3679
|
# {
|
2620
3680
|
# profile_arn: "Arn",
|
2621
3681
|
# profile_name: "ProfileName",
|
3682
|
+
# is_default: false,
|
2622
3683
|
# timezone: "Timezone",
|
2623
3684
|
# address: "Address",
|
2624
3685
|
# distance_unit: "METRIC", # accepts METRIC, IMPERIAL
|
@@ -2637,6 +3698,11 @@ module Aws::AlexaForBusiness
|
|
2637
3698
|
# The updated name for the room profile.
|
2638
3699
|
# @return [String]
|
2639
3700
|
#
|
3701
|
+
# @!attribute [rw] is_default
|
3702
|
+
# Sets the profile as default if selected. If this is missing, no
|
3703
|
+
# update is done to the default status.
|
3704
|
+
# @return [Boolean]
|
3705
|
+
#
|
2640
3706
|
# @!attribute [rw] timezone
|
2641
3707
|
# The updated timezone for the room profile.
|
2642
3708
|
# @return [String]
|
@@ -2674,6 +3740,7 @@ module Aws::AlexaForBusiness
|
|
2674
3740
|
class UpdateProfileRequest < Struct.new(
|
2675
3741
|
:profile_arn,
|
2676
3742
|
:profile_name,
|
3743
|
+
:is_default,
|
2677
3744
|
:timezone,
|
2678
3745
|
:address,
|
2679
3746
|
:distance_unit,
|