aws-sdk-alexaforbusiness 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
File without changes
@@ -0,0 +1,14 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::AlexaForBusiness
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ end
14
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::AlexaForBusiness
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,2071 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::AlexaForBusiness
9
+ module Types
10
+
11
+ # @note When making an API call, you may pass AssociateDeviceWithRoomRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # device_arn: "Arn",
16
+ # room_arn: "Arn",
17
+ # }
18
+ #
19
+ # @!attribute [rw] device_arn
20
+ # The ARN of the device to associate to a room. Required.
21
+ # @return [String]
22
+ #
23
+ # @!attribute [rw] room_arn
24
+ # The ARN of the room with which to associate the device. Required.
25
+ # @return [String]
26
+ #
27
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateDeviceWithRoomRequest AWS API Documentation
28
+ #
29
+ class AssociateDeviceWithRoomRequest < Struct.new(
30
+ :device_arn,
31
+ :room_arn)
32
+ include Aws::Structure
33
+ end
34
+
35
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateDeviceWithRoomResponse AWS API Documentation
36
+ #
37
+ class AssociateDeviceWithRoomResponse < Aws::EmptyStructure; end
38
+
39
+ # @note When making an API call, you may pass AssociateSkillGroupWithRoomRequest
40
+ # data as a hash:
41
+ #
42
+ # {
43
+ # skill_group_arn: "Arn",
44
+ # room_arn: "Arn",
45
+ # }
46
+ #
47
+ # @!attribute [rw] skill_group_arn
48
+ # The ARN of the skill group to associate with a room. Required.
49
+ # @return [String]
50
+ #
51
+ # @!attribute [rw] room_arn
52
+ # The ARN of the room with which to associate the skill group.
53
+ # Required.
54
+ # @return [String]
55
+ #
56
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoomRequest AWS API Documentation
57
+ #
58
+ class AssociateSkillGroupWithRoomRequest < Struct.new(
59
+ :skill_group_arn,
60
+ :room_arn)
61
+ include Aws::Structure
62
+ end
63
+
64
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoomResponse AWS API Documentation
65
+ #
66
+ class AssociateSkillGroupWithRoomResponse < Aws::EmptyStructure; end
67
+
68
+ # @note When making an API call, you may pass CreateProfileRequest
69
+ # data as a hash:
70
+ #
71
+ # {
72
+ # profile_name: "ProfileName", # required
73
+ # timezone: "Timezone", # required
74
+ # address: "Address", # required
75
+ # distance_unit: "METRIC", # required, accepts METRIC, IMPERIAL
76
+ # temperature_unit: "FAHRENHEIT", # required, accepts FAHRENHEIT, CELSIUS
77
+ # wake_word: "ALEXA", # required, accepts ALEXA, AMAZON, ECHO, COMPUTER
78
+ # client_request_token: "ClientRequestToken",
79
+ # setup_mode_disabled: false,
80
+ # max_volume_limit: 1,
81
+ # pstn_enabled: false,
82
+ # }
83
+ #
84
+ # @!attribute [rw] profile_name
85
+ # The name of a room profile.
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] timezone
89
+ # The time zone used by a room profile.
90
+ # @return [String]
91
+ #
92
+ # @!attribute [rw] address
93
+ # The valid address for the room.
94
+ # @return [String]
95
+ #
96
+ # @!attribute [rw] distance_unit
97
+ # The distance unit to be used by devices in the profile.
98
+ # @return [String]
99
+ #
100
+ # @!attribute [rw] temperature_unit
101
+ # The temperature unit to be used by devices in the profile.
102
+ # @return [String]
103
+ #
104
+ # @!attribute [rw] wake_word
105
+ # A wake word for Alexa, Echo, Amazon, or a computer.
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] client_request_token
109
+ # The user-specified token that is used during the creation of a
110
+ # profile.
111
+ #
112
+ # **A suitable default value is auto-generated.** You should normally
113
+ # not need to pass this option.
114
+ # @return [String]
115
+ #
116
+ # @!attribute [rw] setup_mode_disabled
117
+ # Whether room profile setup is enabled.
118
+ # @return [Boolean]
119
+ #
120
+ # @!attribute [rw] max_volume_limit
121
+ # The maximum volume limit for a room profile.
122
+ # @return [Integer]
123
+ #
124
+ # @!attribute [rw] pstn_enabled
125
+ # Whether PSTN calling is enabled.
126
+ # @return [Boolean]
127
+ #
128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateProfileRequest AWS API Documentation
129
+ #
130
+ class CreateProfileRequest < Struct.new(
131
+ :profile_name,
132
+ :timezone,
133
+ :address,
134
+ :distance_unit,
135
+ :temperature_unit,
136
+ :wake_word,
137
+ :client_request_token,
138
+ :setup_mode_disabled,
139
+ :max_volume_limit,
140
+ :pstn_enabled)
141
+ include Aws::Structure
142
+ end
143
+
144
+ # @!attribute [rw] profile_arn
145
+ # The ARN of the newly created room profile in the response.
146
+ # @return [String]
147
+ #
148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateProfileResponse AWS API Documentation
149
+ #
150
+ class CreateProfileResponse < Struct.new(
151
+ :profile_arn)
152
+ include Aws::Structure
153
+ end
154
+
155
+ # @note When making an API call, you may pass CreateRoomRequest
156
+ # data as a hash:
157
+ #
158
+ # {
159
+ # room_name: "RoomName", # required
160
+ # description: "RoomDescription",
161
+ # profile_arn: "Arn",
162
+ # provider_calendar_id: "ProviderCalendarId",
163
+ # client_request_token: "ClientRequestToken",
164
+ # tags: [
165
+ # {
166
+ # key: "TagKey",
167
+ # value: "TagValue",
168
+ # },
169
+ # ],
170
+ # }
171
+ #
172
+ # @!attribute [rw] room_name
173
+ # The name for the room.
174
+ # @return [String]
175
+ #
176
+ # @!attribute [rw] description
177
+ # The description for the room.
178
+ # @return [String]
179
+ #
180
+ # @!attribute [rw] profile_arn
181
+ # The profile ARN for the room.
182
+ # @return [String]
183
+ #
184
+ # @!attribute [rw] provider_calendar_id
185
+ # The calendar ARN for the room.
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] client_request_token
189
+ # A unique, user-specified identifier for this request that ensures
190
+ # idempotency.
191
+ #
192
+ # **A suitable default value is auto-generated.** You should normally
193
+ # not need to pass this option.
194
+ # @return [String]
195
+ #
196
+ # @!attribute [rw] tags
197
+ # The tags for the room.
198
+ # @return [Array<Types::Tag>]
199
+ #
200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateRoomRequest AWS API Documentation
201
+ #
202
+ class CreateRoomRequest < Struct.new(
203
+ :room_name,
204
+ :description,
205
+ :profile_arn,
206
+ :provider_calendar_id,
207
+ :client_request_token,
208
+ :tags)
209
+ include Aws::Structure
210
+ end
211
+
212
+ # @!attribute [rw] room_arn
213
+ # The ARN of the newly created room in the response.
214
+ # @return [String]
215
+ #
216
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateRoomResponse AWS API Documentation
217
+ #
218
+ class CreateRoomResponse < Struct.new(
219
+ :room_arn)
220
+ include Aws::Structure
221
+ end
222
+
223
+ # @note When making an API call, you may pass CreateSkillGroupRequest
224
+ # data as a hash:
225
+ #
226
+ # {
227
+ # skill_group_name: "SkillGroupName", # required
228
+ # description: "SkillGroupDescription",
229
+ # client_request_token: "ClientRequestToken",
230
+ # }
231
+ #
232
+ # @!attribute [rw] skill_group_name
233
+ # The name for the skill group.
234
+ # @return [String]
235
+ #
236
+ # @!attribute [rw] description
237
+ # The description for the skill group.
238
+ # @return [String]
239
+ #
240
+ # @!attribute [rw] client_request_token
241
+ # A unique, user-specified identifier for this request that ensures
242
+ # idempotency.
243
+ #
244
+ # **A suitable default value is auto-generated.** You should normally
245
+ # not need to pass this option.
246
+ # @return [String]
247
+ #
248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateSkillGroupRequest AWS API Documentation
249
+ #
250
+ class CreateSkillGroupRequest < Struct.new(
251
+ :skill_group_name,
252
+ :description,
253
+ :client_request_token)
254
+ include Aws::Structure
255
+ end
256
+
257
+ # @!attribute [rw] skill_group_arn
258
+ # The ARN of the newly created skill group in the response.
259
+ # @return [String]
260
+ #
261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateSkillGroupResponse AWS API Documentation
262
+ #
263
+ class CreateSkillGroupResponse < Struct.new(
264
+ :skill_group_arn)
265
+ include Aws::Structure
266
+ end
267
+
268
+ # @note When making an API call, you may pass CreateUserRequest
269
+ # data as a hash:
270
+ #
271
+ # {
272
+ # user_id: "user_UserId", # required
273
+ # first_name: "user_FirstName",
274
+ # last_name: "user_LastName",
275
+ # email: "Email",
276
+ # client_request_token: "ClientRequestToken",
277
+ # tags: [
278
+ # {
279
+ # key: "TagKey",
280
+ # value: "TagValue",
281
+ # },
282
+ # ],
283
+ # }
284
+ #
285
+ # @!attribute [rw] user_id
286
+ # The ARN for the user.
287
+ # @return [String]
288
+ #
289
+ # @!attribute [rw] first_name
290
+ # The first name for the user.
291
+ # @return [String]
292
+ #
293
+ # @!attribute [rw] last_name
294
+ # The last name for the user.
295
+ # @return [String]
296
+ #
297
+ # @!attribute [rw] email
298
+ # The email address for the user.
299
+ # @return [String]
300
+ #
301
+ # @!attribute [rw] client_request_token
302
+ # A unique, user-specified identifier for this request that ensures
303
+ # idempotency.
304
+ #
305
+ # **A suitable default value is auto-generated.** You should normally
306
+ # not need to pass this option.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] tags
310
+ # The tags for the user.
311
+ # @return [Array<Types::Tag>]
312
+ #
313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateUserRequest AWS API Documentation
314
+ #
315
+ class CreateUserRequest < Struct.new(
316
+ :user_id,
317
+ :first_name,
318
+ :last_name,
319
+ :email,
320
+ :client_request_token,
321
+ :tags)
322
+ include Aws::Structure
323
+ end
324
+
325
+ # @!attribute [rw] user_arn
326
+ # The ARN of the newly created user in the response.
327
+ # @return [String]
328
+ #
329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/CreateUserResponse AWS API Documentation
330
+ #
331
+ class CreateUserResponse < Struct.new(
332
+ :user_arn)
333
+ include Aws::Structure
334
+ end
335
+
336
+ # @note When making an API call, you may pass DeleteProfileRequest
337
+ # data as a hash:
338
+ #
339
+ # {
340
+ # profile_arn: "Arn",
341
+ # }
342
+ #
343
+ # @!attribute [rw] profile_arn
344
+ # The ARN of the room profile to delete. Required.
345
+ # @return [String]
346
+ #
347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteProfileRequest AWS API Documentation
348
+ #
349
+ class DeleteProfileRequest < Struct.new(
350
+ :profile_arn)
351
+ include Aws::Structure
352
+ end
353
+
354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteProfileResponse AWS API Documentation
355
+ #
356
+ class DeleteProfileResponse < Aws::EmptyStructure; end
357
+
358
+ # @note When making an API call, you may pass DeleteRoomRequest
359
+ # data as a hash:
360
+ #
361
+ # {
362
+ # room_arn: "Arn",
363
+ # }
364
+ #
365
+ # @!attribute [rw] room_arn
366
+ # The ARN of the room to delete. Required.
367
+ # @return [String]
368
+ #
369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteRoomRequest AWS API Documentation
370
+ #
371
+ class DeleteRoomRequest < Struct.new(
372
+ :room_arn)
373
+ include Aws::Structure
374
+ end
375
+
376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteRoomResponse AWS API Documentation
377
+ #
378
+ class DeleteRoomResponse < Aws::EmptyStructure; end
379
+
380
+ # @note When making an API call, you may pass DeleteRoomSkillParameterRequest
381
+ # data as a hash:
382
+ #
383
+ # {
384
+ # room_arn: "Arn",
385
+ # skill_id: "SkillId", # required
386
+ # parameter_key: "RoomSkillParameterKey", # required
387
+ # }
388
+ #
389
+ # @!attribute [rw] room_arn
390
+ # The ARN of the room from which to remove the room skill parameter
391
+ # details.
392
+ # @return [String]
393
+ #
394
+ # @!attribute [rw] skill_id
395
+ # The ID of the skill from which to remove the room skill parameter
396
+ # details.
397
+ # @return [String]
398
+ #
399
+ # @!attribute [rw] parameter_key
400
+ # The room skill parameter key for which to remove details.
401
+ # @return [String]
402
+ #
403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteRoomSkillParameterRequest AWS API Documentation
404
+ #
405
+ class DeleteRoomSkillParameterRequest < Struct.new(
406
+ :room_arn,
407
+ :skill_id,
408
+ :parameter_key)
409
+ include Aws::Structure
410
+ end
411
+
412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteRoomSkillParameterResponse AWS API Documentation
413
+ #
414
+ class DeleteRoomSkillParameterResponse < Aws::EmptyStructure; end
415
+
416
+ # @note When making an API call, you may pass DeleteSkillGroupRequest
417
+ # data as a hash:
418
+ #
419
+ # {
420
+ # skill_group_arn: "Arn",
421
+ # }
422
+ #
423
+ # @!attribute [rw] skill_group_arn
424
+ # The ARN of the skill group to delete. Required.
425
+ # @return [String]
426
+ #
427
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteSkillGroupRequest AWS API Documentation
428
+ #
429
+ class DeleteSkillGroupRequest < Struct.new(
430
+ :skill_group_arn)
431
+ include Aws::Structure
432
+ end
433
+
434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteSkillGroupResponse AWS API Documentation
435
+ #
436
+ class DeleteSkillGroupResponse < Aws::EmptyStructure; end
437
+
438
+ # @note When making an API call, you may pass DeleteUserRequest
439
+ # data as a hash:
440
+ #
441
+ # {
442
+ # user_arn: "Arn",
443
+ # enrollment_id: "EnrollmentId", # required
444
+ # }
445
+ #
446
+ # @!attribute [rw] user_arn
447
+ # The ARN of the user to delete in the organization. Required.
448
+ # @return [String]
449
+ #
450
+ # @!attribute [rw] enrollment_id
451
+ # The ARN of the user's enrollment in the organization. Required.
452
+ # @return [String]
453
+ #
454
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteUserRequest AWS API Documentation
455
+ #
456
+ class DeleteUserRequest < Struct.new(
457
+ :user_arn,
458
+ :enrollment_id)
459
+ include Aws::Structure
460
+ end
461
+
462
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeleteUserResponse AWS API Documentation
463
+ #
464
+ class DeleteUserResponse < Aws::EmptyStructure; end
465
+
466
+ # A device with attributes.
467
+ #
468
+ # @!attribute [rw] device_arn
469
+ # The ARN of a device.
470
+ # @return [String]
471
+ #
472
+ # @!attribute [rw] device_serial_number
473
+ # The serial number of a device.
474
+ # @return [String]
475
+ #
476
+ # @!attribute [rw] device_type
477
+ # The type of a device.
478
+ # @return [String]
479
+ #
480
+ # @!attribute [rw] device_name
481
+ # The name of a device.
482
+ # @return [String]
483
+ #
484
+ # @!attribute [rw] software_version
485
+ # The software version of a device.
486
+ # @return [String]
487
+ #
488
+ # @!attribute [rw] mac_address
489
+ # The MAC address of a device.
490
+ # @return [String]
491
+ #
492
+ # @!attribute [rw] room_arn
493
+ # The room ARN of a device.
494
+ # @return [String]
495
+ #
496
+ # @!attribute [rw] device_status
497
+ # The status of a device.
498
+ # @return [String]
499
+ #
500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Device AWS API Documentation
501
+ #
502
+ class Device < Struct.new(
503
+ :device_arn,
504
+ :device_serial_number,
505
+ :device_type,
506
+ :device_name,
507
+ :software_version,
508
+ :mac_address,
509
+ :room_arn,
510
+ :device_status)
511
+ include Aws::Structure
512
+ end
513
+
514
+ # Device attributes.
515
+ #
516
+ # @!attribute [rw] device_arn
517
+ # The ARN of a device.
518
+ # @return [String]
519
+ #
520
+ # @!attribute [rw] device_serial_number
521
+ # The serial number of a device.
522
+ # @return [String]
523
+ #
524
+ # @!attribute [rw] device_type
525
+ # The type of a device.
526
+ # @return [String]
527
+ #
528
+ # @!attribute [rw] device_name
529
+ # The name of a device.
530
+ # @return [String]
531
+ #
532
+ # @!attribute [rw] software_version
533
+ # The software version of a device.
534
+ # @return [String]
535
+ #
536
+ # @!attribute [rw] mac_address
537
+ # The MAC address of a device.
538
+ # @return [String]
539
+ #
540
+ # @!attribute [rw] device_status
541
+ # The status of a device.
542
+ # @return [String]
543
+ #
544
+ # @!attribute [rw] room_arn
545
+ # The room ARN associated with a device.
546
+ # @return [String]
547
+ #
548
+ # @!attribute [rw] room_name
549
+ # The name of the room associated with a device.
550
+ # @return [String]
551
+ #
552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DeviceData AWS API Documentation
553
+ #
554
+ class DeviceData < Struct.new(
555
+ :device_arn,
556
+ :device_serial_number,
557
+ :device_type,
558
+ :device_name,
559
+ :software_version,
560
+ :mac_address,
561
+ :device_status,
562
+ :room_arn,
563
+ :room_name)
564
+ include Aws::Structure
565
+ end
566
+
567
+ # @note When making an API call, you may pass DisassociateDeviceFromRoomRequest
568
+ # data as a hash:
569
+ #
570
+ # {
571
+ # device_arn: "Arn",
572
+ # }
573
+ #
574
+ # @!attribute [rw] device_arn
575
+ # The ARN of the device to disassociate from a room. Required.
576
+ # @return [String]
577
+ #
578
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoomRequest AWS API Documentation
579
+ #
580
+ class DisassociateDeviceFromRoomRequest < Struct.new(
581
+ :device_arn)
582
+ include Aws::Structure
583
+ end
584
+
585
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoomResponse AWS API Documentation
586
+ #
587
+ class DisassociateDeviceFromRoomResponse < Aws::EmptyStructure; end
588
+
589
+ # @note When making an API call, you may pass DisassociateSkillGroupFromRoomRequest
590
+ # data as a hash:
591
+ #
592
+ # {
593
+ # skill_group_arn: "Arn",
594
+ # room_arn: "Arn",
595
+ # }
596
+ #
597
+ # @!attribute [rw] skill_group_arn
598
+ # The ARN of the skill group to disassociate from a room. Required.
599
+ # @return [String]
600
+ #
601
+ # @!attribute [rw] room_arn
602
+ # The ARN of the room from which the skill group is to be
603
+ # disassociated. Required.
604
+ # @return [String]
605
+ #
606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoomRequest AWS API Documentation
607
+ #
608
+ class DisassociateSkillGroupFromRoomRequest < Struct.new(
609
+ :skill_group_arn,
610
+ :room_arn)
611
+ include Aws::Structure
612
+ end
613
+
614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoomResponse AWS API Documentation
615
+ #
616
+ class DisassociateSkillGroupFromRoomResponse < Aws::EmptyStructure; end
617
+
618
+ # A filter name and value pair that is used to return a more specific
619
+ # list of results. Filters can be used to match a set of resources by
620
+ # various criteria.
621
+ #
622
+ # @note When making an API call, you may pass Filter
623
+ # data as a hash:
624
+ #
625
+ # {
626
+ # key: "FilterKey", # required
627
+ # values: ["FilterValue"], # required
628
+ # }
629
+ #
630
+ # @!attribute [rw] key
631
+ # The key of a filter.
632
+ # @return [String]
633
+ #
634
+ # @!attribute [rw] values
635
+ # The values of a filter.
636
+ # @return [Array<String>]
637
+ #
638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Filter AWS API Documentation
639
+ #
640
+ class Filter < Struct.new(
641
+ :key,
642
+ :values)
643
+ include Aws::Structure
644
+ end
645
+
646
+ # @note When making an API call, you may pass GetDeviceRequest
647
+ # data as a hash:
648
+ #
649
+ # {
650
+ # device_arn: "Arn",
651
+ # }
652
+ #
653
+ # @!attribute [rw] device_arn
654
+ # The ARN of the device for which to request details. Required.
655
+ # @return [String]
656
+ #
657
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetDeviceRequest AWS API Documentation
658
+ #
659
+ class GetDeviceRequest < Struct.new(
660
+ :device_arn)
661
+ include Aws::Structure
662
+ end
663
+
664
+ # @!attribute [rw] device
665
+ # The details of the device requested. Required.
666
+ # @return [Types::Device]
667
+ #
668
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetDeviceResponse AWS API Documentation
669
+ #
670
+ class GetDeviceResponse < Struct.new(
671
+ :device)
672
+ include Aws::Structure
673
+ end
674
+
675
+ # @note When making an API call, you may pass GetProfileRequest
676
+ # data as a hash:
677
+ #
678
+ # {
679
+ # profile_arn: "Arn",
680
+ # }
681
+ #
682
+ # @!attribute [rw] profile_arn
683
+ # The ARN of the room profile for which to request details. Required.
684
+ # @return [String]
685
+ #
686
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetProfileRequest AWS API Documentation
687
+ #
688
+ class GetProfileRequest < Struct.new(
689
+ :profile_arn)
690
+ include Aws::Structure
691
+ end
692
+
693
+ # @!attribute [rw] profile
694
+ # The details of the room profile requested. Required.
695
+ # @return [Types::Profile]
696
+ #
697
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetProfileResponse AWS API Documentation
698
+ #
699
+ class GetProfileResponse < Struct.new(
700
+ :profile)
701
+ include Aws::Structure
702
+ end
703
+
704
+ # @note When making an API call, you may pass GetRoomRequest
705
+ # data as a hash:
706
+ #
707
+ # {
708
+ # room_arn: "Arn",
709
+ # }
710
+ #
711
+ # @!attribute [rw] room_arn
712
+ # The ARN of the room for which to request details. Required.
713
+ # @return [String]
714
+ #
715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetRoomRequest AWS API Documentation
716
+ #
717
+ class GetRoomRequest < Struct.new(
718
+ :room_arn)
719
+ include Aws::Structure
720
+ end
721
+
722
+ # @!attribute [rw] room
723
+ # The details of the room requested.
724
+ # @return [Types::Room]
725
+ #
726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetRoomResponse AWS API Documentation
727
+ #
728
+ class GetRoomResponse < Struct.new(
729
+ :room)
730
+ include Aws::Structure
731
+ end
732
+
733
+ # @note When making an API call, you may pass GetRoomSkillParameterRequest
734
+ # data as a hash:
735
+ #
736
+ # {
737
+ # room_arn: "Arn",
738
+ # skill_id: "SkillId", # required
739
+ # parameter_key: "RoomSkillParameterKey", # required
740
+ # }
741
+ #
742
+ # @!attribute [rw] room_arn
743
+ # The ARN of the room from which to get the room skill parameter
744
+ # details.
745
+ # @return [String]
746
+ #
747
+ # @!attribute [rw] skill_id
748
+ # The ARN of the skill from which to get the room skill parameter
749
+ # details. Required.
750
+ # @return [String]
751
+ #
752
+ # @!attribute [rw] parameter_key
753
+ # The room skill parameter key for which to get details. Required.
754
+ # @return [String]
755
+ #
756
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetRoomSkillParameterRequest AWS API Documentation
757
+ #
758
+ class GetRoomSkillParameterRequest < Struct.new(
759
+ :room_arn,
760
+ :skill_id,
761
+ :parameter_key)
762
+ include Aws::Structure
763
+ end
764
+
765
+ # @!attribute [rw] room_skill_parameter
766
+ # The details of the room skill parameter requested. Required.
767
+ # @return [Types::RoomSkillParameter]
768
+ #
769
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetRoomSkillParameterResponse AWS API Documentation
770
+ #
771
+ class GetRoomSkillParameterResponse < Struct.new(
772
+ :room_skill_parameter)
773
+ include Aws::Structure
774
+ end
775
+
776
+ # @note When making an API call, you may pass GetSkillGroupRequest
777
+ # data as a hash:
778
+ #
779
+ # {
780
+ # skill_group_arn: "Arn",
781
+ # }
782
+ #
783
+ # @!attribute [rw] skill_group_arn
784
+ # The ARN of the skill group for which to get details. Required.
785
+ # @return [String]
786
+ #
787
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetSkillGroupRequest AWS API Documentation
788
+ #
789
+ class GetSkillGroupRequest < Struct.new(
790
+ :skill_group_arn)
791
+ include Aws::Structure
792
+ end
793
+
794
+ # @!attribute [rw] skill_group
795
+ # The details of the skill group requested. Required.
796
+ # @return [Types::SkillGroup]
797
+ #
798
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/GetSkillGroupResponse AWS API Documentation
799
+ #
800
+ class GetSkillGroupResponse < Struct.new(
801
+ :skill_group)
802
+ include Aws::Structure
803
+ end
804
+
805
+ # @note When making an API call, you may pass ListSkillsRequest
806
+ # data as a hash:
807
+ #
808
+ # {
809
+ # skill_group_arn: "Arn",
810
+ # next_token: "NextToken",
811
+ # max_results: 1,
812
+ # }
813
+ #
814
+ # @!attribute [rw] skill_group_arn
815
+ # The ARN of the skill group for which to list enabled skills.
816
+ # Required.
817
+ # @return [String]
818
+ #
819
+ # @!attribute [rw] next_token
820
+ # An optional token returned from a prior request. Use this token for
821
+ # pagination of results from this action. If this parameter is
822
+ # specified, the response includes only results beyond the token, up
823
+ # to the value specified by `MaxResults`. Required.
824
+ # @return [String]
825
+ #
826
+ # @!attribute [rw] max_results
827
+ # The maximum number of results to include in the response. If more
828
+ # results exist than the specified `MaxResults` value, a token is
829
+ # included in the response so that the remaining results can be
830
+ # retrieved. Required.
831
+ # @return [Integer]
832
+ #
833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSkillsRequest AWS API Documentation
834
+ #
835
+ class ListSkillsRequest < Struct.new(
836
+ :skill_group_arn,
837
+ :next_token,
838
+ :max_results)
839
+ include Aws::Structure
840
+ end
841
+
842
+ # @!attribute [rw] skill_summaries
843
+ # The list of enabled skills requested. Required.
844
+ # @return [Array<Types::SkillSummary>]
845
+ #
846
+ # @!attribute [rw] next_token
847
+ # The token returned to indicate that there is more data available.
848
+ # @return [String]
849
+ #
850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListSkillsResponse AWS API Documentation
851
+ #
852
+ class ListSkillsResponse < Struct.new(
853
+ :skill_summaries,
854
+ :next_token)
855
+ include Aws::Structure
856
+ end
857
+
858
+ # @note When making an API call, you may pass ListTagsRequest
859
+ # data as a hash:
860
+ #
861
+ # {
862
+ # arn: "Arn", # required
863
+ # next_token: "NextToken",
864
+ # max_results: 1,
865
+ # }
866
+ #
867
+ # @!attribute [rw] arn
868
+ # The ARN of the specific resource for which to list tags. Required.
869
+ # @return [String]
870
+ #
871
+ # @!attribute [rw] next_token
872
+ # An optional token returned from a prior request. Use this token for
873
+ # pagination of results from this action. If this parameter is
874
+ # specified, the response includes only results beyond the token, up
875
+ # to the value specified by `MaxResults`.
876
+ # @return [String]
877
+ #
878
+ # @!attribute [rw] max_results
879
+ # The maximum number of results to include in the response. If more
880
+ # results exist than the specified `MaxResults` value, a token is
881
+ # included in the response so that the remaining results can be
882
+ # retrieved.
883
+ # @return [Integer]
884
+ #
885
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListTagsRequest AWS API Documentation
886
+ #
887
+ class ListTagsRequest < Struct.new(
888
+ :arn,
889
+ :next_token,
890
+ :max_results)
891
+ include Aws::Structure
892
+ end
893
+
894
+ # @!attribute [rw] tags
895
+ # The list of tags requested for the specific resource.
896
+ # @return [Array<Types::Tag>]
897
+ #
898
+ # @!attribute [rw] next_token
899
+ # The token returned to indicate that there is more data available.
900
+ # @return [String]
901
+ #
902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ListTagsResponse AWS API Documentation
903
+ #
904
+ class ListTagsResponse < Struct.new(
905
+ :tags,
906
+ :next_token)
907
+ include Aws::Structure
908
+ end
909
+
910
+ # A room profile with attributes.
911
+ #
912
+ # @!attribute [rw] profile_arn
913
+ # The ARN of a room profile.
914
+ # @return [String]
915
+ #
916
+ # @!attribute [rw] profile_name
917
+ # The name of a room profile.
918
+ # @return [String]
919
+ #
920
+ # @!attribute [rw] address
921
+ # The address of a room profile.
922
+ # @return [String]
923
+ #
924
+ # @!attribute [rw] timezone
925
+ # The time zone of a room profile.
926
+ # @return [String]
927
+ #
928
+ # @!attribute [rw] distance_unit
929
+ # The distance unit of a room profile.
930
+ # @return [String]
931
+ #
932
+ # @!attribute [rw] temperature_unit
933
+ # The temperature unit of a room profile.
934
+ # @return [String]
935
+ #
936
+ # @!attribute [rw] wake_word
937
+ # The wake word of a room profile.
938
+ # @return [String]
939
+ #
940
+ # @!attribute [rw] setup_mode_disabled
941
+ # The setup mode of a room profile.
942
+ # @return [Boolean]
943
+ #
944
+ # @!attribute [rw] max_volume_limit
945
+ # The max volume limit of a room profile.
946
+ # @return [Integer]
947
+ #
948
+ # @!attribute [rw] pstn_enabled
949
+ # The PSTN setting of a room profile.
950
+ # @return [Boolean]
951
+ #
952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Profile AWS API Documentation
953
+ #
954
+ class Profile < Struct.new(
955
+ :profile_arn,
956
+ :profile_name,
957
+ :address,
958
+ :timezone,
959
+ :distance_unit,
960
+ :temperature_unit,
961
+ :wake_word,
962
+ :setup_mode_disabled,
963
+ :max_volume_limit,
964
+ :pstn_enabled)
965
+ include Aws::Structure
966
+ end
967
+
968
+ # The data of a room profile.
969
+ #
970
+ # @!attribute [rw] profile_arn
971
+ # The ARN of a room profile.
972
+ # @return [String]
973
+ #
974
+ # @!attribute [rw] profile_name
975
+ # The name of a room profile.
976
+ # @return [String]
977
+ #
978
+ # @!attribute [rw] address
979
+ # The address of a room profile.
980
+ # @return [String]
981
+ #
982
+ # @!attribute [rw] timezone
983
+ # The timezone of a room profile.
984
+ # @return [String]
985
+ #
986
+ # @!attribute [rw] distance_unit
987
+ # The distance unit of a room profile.
988
+ # @return [String]
989
+ #
990
+ # @!attribute [rw] temperature_unit
991
+ # The temperature unit of a room profile.
992
+ # @return [String]
993
+ #
994
+ # @!attribute [rw] wake_word
995
+ # The wake word of a room profile.
996
+ # @return [String]
997
+ #
998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ProfileData AWS API Documentation
999
+ #
1000
+ class ProfileData < Struct.new(
1001
+ :profile_arn,
1002
+ :profile_name,
1003
+ :address,
1004
+ :timezone,
1005
+ :distance_unit,
1006
+ :temperature_unit,
1007
+ :wake_word)
1008
+ include Aws::Structure
1009
+ end
1010
+
1011
+ # @note When making an API call, you may pass PutRoomSkillParameterRequest
1012
+ # data as a hash:
1013
+ #
1014
+ # {
1015
+ # room_arn: "Arn",
1016
+ # skill_id: "SkillId", # required
1017
+ # room_skill_parameter: { # required
1018
+ # parameter_key: "RoomSkillParameterKey", # required
1019
+ # parameter_value: "RoomSkillParameterValue", # required
1020
+ # },
1021
+ # }
1022
+ #
1023
+ # @!attribute [rw] room_arn
1024
+ # The ARN of the room associated with the room skill parameter.
1025
+ # Required.
1026
+ # @return [String]
1027
+ #
1028
+ # @!attribute [rw] skill_id
1029
+ # The ARN of the skill associated with the room skill parameter.
1030
+ # Required.
1031
+ # @return [String]
1032
+ #
1033
+ # @!attribute [rw] room_skill_parameter
1034
+ # The updated room skill parameter. Required.
1035
+ # @return [Types::RoomSkillParameter]
1036
+ #
1037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/PutRoomSkillParameterRequest AWS API Documentation
1038
+ #
1039
+ class PutRoomSkillParameterRequest < Struct.new(
1040
+ :room_arn,
1041
+ :skill_id,
1042
+ :room_skill_parameter)
1043
+ include Aws::Structure
1044
+ end
1045
+
1046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/PutRoomSkillParameterResponse AWS API Documentation
1047
+ #
1048
+ class PutRoomSkillParameterResponse < Aws::EmptyStructure; end
1049
+
1050
+ # @note When making an API call, you may pass ResolveRoomRequest
1051
+ # data as a hash:
1052
+ #
1053
+ # {
1054
+ # user_id: "UserId", # required
1055
+ # skill_id: "SkillId", # required
1056
+ # }
1057
+ #
1058
+ # @!attribute [rw] user_id
1059
+ # The ARN of the user. Required.
1060
+ # @return [String]
1061
+ #
1062
+ # @!attribute [rw] skill_id
1063
+ # The ARN of the skill that was requested. Required.
1064
+ # @return [String]
1065
+ #
1066
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ResolveRoomRequest AWS API Documentation
1067
+ #
1068
+ class ResolveRoomRequest < Struct.new(
1069
+ :user_id,
1070
+ :skill_id)
1071
+ include Aws::Structure
1072
+ end
1073
+
1074
+ # @!attribute [rw] room_arn
1075
+ # The ARN of the room from which the skill request was invoked.
1076
+ # @return [String]
1077
+ #
1078
+ # @!attribute [rw] room_name
1079
+ # The name of the room from which the skill request was invoked.
1080
+ # @return [String]
1081
+ #
1082
+ # @!attribute [rw] room_skill_parameters
1083
+ # Response to get the room profile request. Required.
1084
+ # @return [Array<Types::RoomSkillParameter>]
1085
+ #
1086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/ResolveRoomResponse AWS API Documentation
1087
+ #
1088
+ class ResolveRoomResponse < Struct.new(
1089
+ :room_arn,
1090
+ :room_name,
1091
+ :room_skill_parameters)
1092
+ include Aws::Structure
1093
+ end
1094
+
1095
+ # @note When making an API call, you may pass RevokeInvitationRequest
1096
+ # data as a hash:
1097
+ #
1098
+ # {
1099
+ # user_arn: "Arn",
1100
+ # enrollment_id: "EnrollmentId",
1101
+ # }
1102
+ #
1103
+ # @!attribute [rw] user_arn
1104
+ # The ARN of the user for whom to revoke an enrollment invitation.
1105
+ # Required.
1106
+ # @return [String]
1107
+ #
1108
+ # @!attribute [rw] enrollment_id
1109
+ # The ARN of the enrollment invitation to revoke. Required.
1110
+ # @return [String]
1111
+ #
1112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RevokeInvitationRequest AWS API Documentation
1113
+ #
1114
+ class RevokeInvitationRequest < Struct.new(
1115
+ :user_arn,
1116
+ :enrollment_id)
1117
+ include Aws::Structure
1118
+ end
1119
+
1120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RevokeInvitationResponse AWS API Documentation
1121
+ #
1122
+ class RevokeInvitationResponse < Aws::EmptyStructure; end
1123
+
1124
+ # A room with attributes.
1125
+ #
1126
+ # @!attribute [rw] room_arn
1127
+ # The ARN of a room.
1128
+ # @return [String]
1129
+ #
1130
+ # @!attribute [rw] room_name
1131
+ # The name of a room.
1132
+ # @return [String]
1133
+ #
1134
+ # @!attribute [rw] description
1135
+ # The description of a room.
1136
+ # @return [String]
1137
+ #
1138
+ # @!attribute [rw] provider_calendar_id
1139
+ # The provider calendar ARN of a room.
1140
+ # @return [String]
1141
+ #
1142
+ # @!attribute [rw] profile_arn
1143
+ # The profile ARN of a room.
1144
+ # @return [String]
1145
+ #
1146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Room AWS API Documentation
1147
+ #
1148
+ class Room < Struct.new(
1149
+ :room_arn,
1150
+ :room_name,
1151
+ :description,
1152
+ :provider_calendar_id,
1153
+ :profile_arn)
1154
+ include Aws::Structure
1155
+ end
1156
+
1157
+ # The data of a room.
1158
+ #
1159
+ # @!attribute [rw] room_arn
1160
+ # The ARN of a room.
1161
+ # @return [String]
1162
+ #
1163
+ # @!attribute [rw] room_name
1164
+ # The name of a room.
1165
+ # @return [String]
1166
+ #
1167
+ # @!attribute [rw] description
1168
+ # The description of a room.
1169
+ # @return [String]
1170
+ #
1171
+ # @!attribute [rw] provider_calendar_id
1172
+ # The provider calendar ARN of a room.
1173
+ # @return [String]
1174
+ #
1175
+ # @!attribute [rw] profile_arn
1176
+ # The profile ARN of a room.
1177
+ # @return [String]
1178
+ #
1179
+ # @!attribute [rw] profile_name
1180
+ # The profile name of a room.
1181
+ # @return [String]
1182
+ #
1183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RoomData AWS API Documentation
1184
+ #
1185
+ class RoomData < Struct.new(
1186
+ :room_arn,
1187
+ :room_name,
1188
+ :description,
1189
+ :provider_calendar_id,
1190
+ :profile_arn,
1191
+ :profile_name)
1192
+ include Aws::Structure
1193
+ end
1194
+
1195
+ # A skill parameter associated with a room.
1196
+ #
1197
+ # @note When making an API call, you may pass RoomSkillParameter
1198
+ # data as a hash:
1199
+ #
1200
+ # {
1201
+ # parameter_key: "RoomSkillParameterKey", # required
1202
+ # parameter_value: "RoomSkillParameterValue", # required
1203
+ # }
1204
+ #
1205
+ # @!attribute [rw] parameter_key
1206
+ # The parameter key of a room skill parameter. ParameterKey is an
1207
+ # enumerated type that only takes “DEFAULT” or “SCOPE” as valid
1208
+ # values.
1209
+ # @return [String]
1210
+ #
1211
+ # @!attribute [rw] parameter_value
1212
+ # The parameter value of a room skill parameter.
1213
+ # @return [String]
1214
+ #
1215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/RoomSkillParameter AWS API Documentation
1216
+ #
1217
+ class RoomSkillParameter < Struct.new(
1218
+ :parameter_key,
1219
+ :parameter_value)
1220
+ include Aws::Structure
1221
+ end
1222
+
1223
+ # @note When making an API call, you may pass SearchDevicesRequest
1224
+ # data as a hash:
1225
+ #
1226
+ # {
1227
+ # next_token: "NextToken",
1228
+ # max_results: 1,
1229
+ # filters: [
1230
+ # {
1231
+ # key: "FilterKey", # required
1232
+ # values: ["FilterValue"], # required
1233
+ # },
1234
+ # ],
1235
+ # sort_criteria: [
1236
+ # {
1237
+ # key: "SortKey", # required
1238
+ # value: "ASC", # required, accepts ASC, DESC
1239
+ # },
1240
+ # ],
1241
+ # }
1242
+ #
1243
+ # @!attribute [rw] next_token
1244
+ # An optional token returned from a prior request. Use this token for
1245
+ # pagination of results from this action. If this parameter is
1246
+ # specified, the response includes only results beyond the token, up
1247
+ # to the value specified by `MaxResults`.
1248
+ # @return [String]
1249
+ #
1250
+ # @!attribute [rw] max_results
1251
+ # The maximum number of results to include in the response. If more
1252
+ # results exist than the specified `MaxResults` value, a token is
1253
+ # included in the response so that the remaining results can be
1254
+ # retrieved.
1255
+ # @return [Integer]
1256
+ #
1257
+ # @!attribute [rw] filters
1258
+ # The filters to use to list a specified set of devices. Supported
1259
+ # filter keys are DeviceName, DeviceStatus, RoomName, DeviceType,
1260
+ # DeviceSerialNumber, and UnassociatedOnly.
1261
+ # @return [Array<Types::Filter>]
1262
+ #
1263
+ # @!attribute [rw] sort_criteria
1264
+ # The sort order to use in listing the specified set of devices.
1265
+ # Supported sort keys are DeviceName, DeviceStatus, RoomName,
1266
+ # DeviceType, and DeviceSerialNumber.
1267
+ # @return [Array<Types::Sort>]
1268
+ #
1269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchDevicesRequest AWS API Documentation
1270
+ #
1271
+ class SearchDevicesRequest < Struct.new(
1272
+ :next_token,
1273
+ :max_results,
1274
+ :filters,
1275
+ :sort_criteria)
1276
+ include Aws::Structure
1277
+ end
1278
+
1279
+ # @!attribute [rw] devices
1280
+ # The devices that meet the specified set of filter criteria, in sort
1281
+ # order.
1282
+ # @return [Array<Types::DeviceData>]
1283
+ #
1284
+ # @!attribute [rw] next_token
1285
+ # The token returned to indicate that there is more data available.
1286
+ # @return [String]
1287
+ #
1288
+ # @!attribute [rw] total_count
1289
+ # The total number of devices returned.
1290
+ # @return [Integer]
1291
+ #
1292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchDevicesResponse AWS API Documentation
1293
+ #
1294
+ class SearchDevicesResponse < Struct.new(
1295
+ :devices,
1296
+ :next_token,
1297
+ :total_count)
1298
+ include Aws::Structure
1299
+ end
1300
+
1301
+ # @note When making an API call, you may pass SearchProfilesRequest
1302
+ # data as a hash:
1303
+ #
1304
+ # {
1305
+ # next_token: "NextToken",
1306
+ # max_results: 1,
1307
+ # filters: [
1308
+ # {
1309
+ # key: "FilterKey", # required
1310
+ # values: ["FilterValue"], # required
1311
+ # },
1312
+ # ],
1313
+ # sort_criteria: [
1314
+ # {
1315
+ # key: "SortKey", # required
1316
+ # value: "ASC", # required, accepts ASC, DESC
1317
+ # },
1318
+ # ],
1319
+ # }
1320
+ #
1321
+ # @!attribute [rw] next_token
1322
+ # An optional token returned from a prior request. Use this token for
1323
+ # pagination of results from this action. If this parameter is
1324
+ # specified, the response includes only results beyond the token, up
1325
+ # to the value specified by `MaxResults`.
1326
+ # @return [String]
1327
+ #
1328
+ # @!attribute [rw] max_results
1329
+ # The maximum number of results to include in the response. If more
1330
+ # results exist than the specified `MaxResults` value, a token is
1331
+ # included in the response so that the remaining results can be
1332
+ # retrieved.
1333
+ # @return [Integer]
1334
+ #
1335
+ # @!attribute [rw] filters
1336
+ # The filters to use to list a specified set of room profiles.
1337
+ # Supported filter keys are ProfileName and Address. Required.
1338
+ # @return [Array<Types::Filter>]
1339
+ #
1340
+ # @!attribute [rw] sort_criteria
1341
+ # The sort order to use in listing the specified set of room profiles.
1342
+ # Supported sort keys are ProfileName and Address.
1343
+ # @return [Array<Types::Sort>]
1344
+ #
1345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchProfilesRequest AWS API Documentation
1346
+ #
1347
+ class SearchProfilesRequest < Struct.new(
1348
+ :next_token,
1349
+ :max_results,
1350
+ :filters,
1351
+ :sort_criteria)
1352
+ include Aws::Structure
1353
+ end
1354
+
1355
+ # @!attribute [rw] profiles
1356
+ # The profiles that meet the specified set of filter criteria, in sort
1357
+ # order.
1358
+ # @return [Array<Types::ProfileData>]
1359
+ #
1360
+ # @!attribute [rw] next_token
1361
+ # The token returned to indicate that there is more data available.
1362
+ # @return [String]
1363
+ #
1364
+ # @!attribute [rw] total_count
1365
+ # The total number of room profiles returned.
1366
+ # @return [Integer]
1367
+ #
1368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchProfilesResponse AWS API Documentation
1369
+ #
1370
+ class SearchProfilesResponse < Struct.new(
1371
+ :profiles,
1372
+ :next_token,
1373
+ :total_count)
1374
+ include Aws::Structure
1375
+ end
1376
+
1377
+ # @note When making an API call, you may pass SearchRoomsRequest
1378
+ # data as a hash:
1379
+ #
1380
+ # {
1381
+ # next_token: "NextToken",
1382
+ # max_results: 1,
1383
+ # filters: [
1384
+ # {
1385
+ # key: "FilterKey", # required
1386
+ # values: ["FilterValue"], # required
1387
+ # },
1388
+ # ],
1389
+ # sort_criteria: [
1390
+ # {
1391
+ # key: "SortKey", # required
1392
+ # value: "ASC", # required, accepts ASC, DESC
1393
+ # },
1394
+ # ],
1395
+ # }
1396
+ #
1397
+ # @!attribute [rw] next_token
1398
+ # An optional token returned from a prior request. Use this token for
1399
+ # pagination of results from this action. If this parameter is
1400
+ # specified, the response includes only results beyond the token, up
1401
+ # to the value specified by `MaxResults`.
1402
+ # @return [String]
1403
+ #
1404
+ # @!attribute [rw] max_results
1405
+ # The maximum number of results to include in the response. If more
1406
+ # results exist than the specified `MaxResults` value, a token is
1407
+ # included in the response so that the remaining results can be
1408
+ # retrieved.
1409
+ # @return [Integer]
1410
+ #
1411
+ # @!attribute [rw] filters
1412
+ # The filters to use to list a specified set of rooms. The supported
1413
+ # filter keys are RoomName and ProfileName.
1414
+ # @return [Array<Types::Filter>]
1415
+ #
1416
+ # @!attribute [rw] sort_criteria
1417
+ # The sort order to use in listing the specified set of rooms. The
1418
+ # supported sort keys are RoomName and ProfileName.
1419
+ # @return [Array<Types::Sort>]
1420
+ #
1421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchRoomsRequest AWS API Documentation
1422
+ #
1423
+ class SearchRoomsRequest < Struct.new(
1424
+ :next_token,
1425
+ :max_results,
1426
+ :filters,
1427
+ :sort_criteria)
1428
+ include Aws::Structure
1429
+ end
1430
+
1431
+ # @!attribute [rw] rooms
1432
+ # The rooms that meet the specified set of filter criteria, in sort
1433
+ # order.
1434
+ # @return [Array<Types::RoomData>]
1435
+ #
1436
+ # @!attribute [rw] next_token
1437
+ # The token returned to indicate that there is more data available.
1438
+ # @return [String]
1439
+ #
1440
+ # @!attribute [rw] total_count
1441
+ # The total number of rooms returned.
1442
+ # @return [Integer]
1443
+ #
1444
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchRoomsResponse AWS API Documentation
1445
+ #
1446
+ class SearchRoomsResponse < Struct.new(
1447
+ :rooms,
1448
+ :next_token,
1449
+ :total_count)
1450
+ include Aws::Structure
1451
+ end
1452
+
1453
+ # @note When making an API call, you may pass SearchSkillGroupsRequest
1454
+ # data as a hash:
1455
+ #
1456
+ # {
1457
+ # next_token: "NextToken",
1458
+ # max_results: 1,
1459
+ # filters: [
1460
+ # {
1461
+ # key: "FilterKey", # required
1462
+ # values: ["FilterValue"], # required
1463
+ # },
1464
+ # ],
1465
+ # sort_criteria: [
1466
+ # {
1467
+ # key: "SortKey", # required
1468
+ # value: "ASC", # required, accepts ASC, DESC
1469
+ # },
1470
+ # ],
1471
+ # }
1472
+ #
1473
+ # @!attribute [rw] next_token
1474
+ # An optional token returned from a prior request. Use this token for
1475
+ # pagination of results from this action. If this parameter is
1476
+ # specified, the response includes only results beyond the token, up
1477
+ # to the value specified by `MaxResults`. Required.
1478
+ # @return [String]
1479
+ #
1480
+ # @!attribute [rw] max_results
1481
+ # The maximum number of results to include in the response. If more
1482
+ # results exist than the specified `MaxResults` value, a token is
1483
+ # included in the response so that the remaining results can be
1484
+ # retrieved.
1485
+ # @return [Integer]
1486
+ #
1487
+ # @!attribute [rw] filters
1488
+ # The filters to use to list a specified set of skill groups. The
1489
+ # supported filter key is SkillGroupName.
1490
+ # @return [Array<Types::Filter>]
1491
+ #
1492
+ # @!attribute [rw] sort_criteria
1493
+ # The sort order to use in listing the specified set of skill groups.
1494
+ # The supported sort key is SkillGroupName.
1495
+ # @return [Array<Types::Sort>]
1496
+ #
1497
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchSkillGroupsRequest AWS API Documentation
1498
+ #
1499
+ class SearchSkillGroupsRequest < Struct.new(
1500
+ :next_token,
1501
+ :max_results,
1502
+ :filters,
1503
+ :sort_criteria)
1504
+ include Aws::Structure
1505
+ end
1506
+
1507
+ # @!attribute [rw] skill_groups
1508
+ # The skill groups that meet the filter criteria, in sort order.
1509
+ # @return [Array<Types::SkillGroupData>]
1510
+ #
1511
+ # @!attribute [rw] next_token
1512
+ # The token returned to indicate that there is more data available.
1513
+ # @return [String]
1514
+ #
1515
+ # @!attribute [rw] total_count
1516
+ # The total number of skill groups returned.
1517
+ # @return [Integer]
1518
+ #
1519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchSkillGroupsResponse AWS API Documentation
1520
+ #
1521
+ class SearchSkillGroupsResponse < Struct.new(
1522
+ :skill_groups,
1523
+ :next_token,
1524
+ :total_count)
1525
+ include Aws::Structure
1526
+ end
1527
+
1528
+ # @note When making an API call, you may pass SearchUsersRequest
1529
+ # data as a hash:
1530
+ #
1531
+ # {
1532
+ # next_token: "NextToken",
1533
+ # max_results: 1,
1534
+ # filters: [
1535
+ # {
1536
+ # key: "FilterKey", # required
1537
+ # values: ["FilterValue"], # required
1538
+ # },
1539
+ # ],
1540
+ # sort_criteria: [
1541
+ # {
1542
+ # key: "SortKey", # required
1543
+ # value: "ASC", # required, accepts ASC, DESC
1544
+ # },
1545
+ # ],
1546
+ # }
1547
+ #
1548
+ # @!attribute [rw] next_token
1549
+ # An optional token returned from a prior request. Use this token for
1550
+ # pagination of results from this action. If this parameter is
1551
+ # specified, the response includes only results beyond the token, up
1552
+ # to the value specified by `MaxResults`. Required.
1553
+ # @return [String]
1554
+ #
1555
+ # @!attribute [rw] max_results
1556
+ # The maximum number of results to include in the response. If more
1557
+ # results exist than the specified `MaxResults` value, a token is
1558
+ # included in the response so that the remaining results can be
1559
+ # retrieved. Required.
1560
+ # @return [Integer]
1561
+ #
1562
+ # @!attribute [rw] filters
1563
+ # The filters to use for listing a specific set of users. Required.
1564
+ # Supported filter keys are UserId, FirstName, LastName, Email, and
1565
+ # EnrollmentStatus.
1566
+ # @return [Array<Types::Filter>]
1567
+ #
1568
+ # @!attribute [rw] sort_criteria
1569
+ # The sort order to use in listing the filtered set of users.
1570
+ # Required. Supported sort keys are UserId, FirstName, LastName,
1571
+ # Email, and EnrollmentStatus.
1572
+ # @return [Array<Types::Sort>]
1573
+ #
1574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchUsersRequest AWS API Documentation
1575
+ #
1576
+ class SearchUsersRequest < Struct.new(
1577
+ :next_token,
1578
+ :max_results,
1579
+ :filters,
1580
+ :sort_criteria)
1581
+ include Aws::Structure
1582
+ end
1583
+
1584
+ # @!attribute [rw] users
1585
+ # The users that meet the specified set of filter criteria, in sort
1586
+ # order.
1587
+ # @return [Array<Types::UserData>]
1588
+ #
1589
+ # @!attribute [rw] next_token
1590
+ # The token returned to indicate that there is more data available.
1591
+ # @return [String]
1592
+ #
1593
+ # @!attribute [rw] total_count
1594
+ # The total number of users returned.
1595
+ # @return [Integer]
1596
+ #
1597
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SearchUsersResponse AWS API Documentation
1598
+ #
1599
+ class SearchUsersResponse < Struct.new(
1600
+ :users,
1601
+ :next_token,
1602
+ :total_count)
1603
+ include Aws::Structure
1604
+ end
1605
+
1606
+ # @note When making an API call, you may pass SendInvitationRequest
1607
+ # data as a hash:
1608
+ #
1609
+ # {
1610
+ # user_arn: "Arn",
1611
+ # }
1612
+ #
1613
+ # @!attribute [rw] user_arn
1614
+ # The ARN of the user to whom to send an invitation. Required.
1615
+ # @return [String]
1616
+ #
1617
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SendInvitationRequest AWS API Documentation
1618
+ #
1619
+ class SendInvitationRequest < Struct.new(
1620
+ :user_arn)
1621
+ include Aws::Structure
1622
+ end
1623
+
1624
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SendInvitationResponse AWS API Documentation
1625
+ #
1626
+ class SendInvitationResponse < Aws::EmptyStructure; end
1627
+
1628
+ # A skill group with attributes.
1629
+ #
1630
+ # @!attribute [rw] skill_group_arn
1631
+ # The ARN of a skill group.
1632
+ # @return [String]
1633
+ #
1634
+ # @!attribute [rw] skill_group_name
1635
+ # The name of a skill group.
1636
+ # @return [String]
1637
+ #
1638
+ # @!attribute [rw] description
1639
+ # The description of a skill group.
1640
+ # @return [String]
1641
+ #
1642
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SkillGroup AWS API Documentation
1643
+ #
1644
+ class SkillGroup < Struct.new(
1645
+ :skill_group_arn,
1646
+ :skill_group_name,
1647
+ :description)
1648
+ include Aws::Structure
1649
+ end
1650
+
1651
+ # The attributes of a skill group.
1652
+ #
1653
+ # @!attribute [rw] skill_group_arn
1654
+ # The skill group ARN of a skill group.
1655
+ # @return [String]
1656
+ #
1657
+ # @!attribute [rw] skill_group_name
1658
+ # The skill group name of a skill group.
1659
+ # @return [String]
1660
+ #
1661
+ # @!attribute [rw] description
1662
+ # The description of a skill group.
1663
+ # @return [String]
1664
+ #
1665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SkillGroupData AWS API Documentation
1666
+ #
1667
+ class SkillGroupData < Struct.new(
1668
+ :skill_group_arn,
1669
+ :skill_group_name,
1670
+ :description)
1671
+ include Aws::Structure
1672
+ end
1673
+
1674
+ # The summary of skills.
1675
+ #
1676
+ # @!attribute [rw] skill_id
1677
+ # The ARN of the skill summary.
1678
+ # @return [String]
1679
+ #
1680
+ # @!attribute [rw] skill_name
1681
+ # The name of the skill.
1682
+ # @return [String]
1683
+ #
1684
+ # @!attribute [rw] supports_linking
1685
+ # Linking support for a skill.
1686
+ # @return [Boolean]
1687
+ #
1688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/SkillSummary AWS API Documentation
1689
+ #
1690
+ class SkillSummary < Struct.new(
1691
+ :skill_id,
1692
+ :skill_name,
1693
+ :supports_linking)
1694
+ include Aws::Structure
1695
+ end
1696
+
1697
+ # An object representing a sort criteria.
1698
+ #
1699
+ # @note When making an API call, you may pass Sort
1700
+ # data as a hash:
1701
+ #
1702
+ # {
1703
+ # key: "SortKey", # required
1704
+ # value: "ASC", # required, accepts ASC, DESC
1705
+ # }
1706
+ #
1707
+ # @!attribute [rw] key
1708
+ # The sort key of a sort object.
1709
+ # @return [String]
1710
+ #
1711
+ # @!attribute [rw] value
1712
+ # The sort value of a sort object.
1713
+ # @return [String]
1714
+ #
1715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Sort AWS API Documentation
1716
+ #
1717
+ class Sort < Struct.new(
1718
+ :key,
1719
+ :value)
1720
+ include Aws::Structure
1721
+ end
1722
+
1723
+ # @note When making an API call, you may pass StartDeviceSyncRequest
1724
+ # data as a hash:
1725
+ #
1726
+ # {
1727
+ # room_arn: "Arn",
1728
+ # device_arn: "Arn",
1729
+ # features: ["BLUETOOTH"], # required, accepts BLUETOOTH, VOLUME, NOTIFICATIONS, LISTS, SKILLS, ALL
1730
+ # }
1731
+ #
1732
+ # @!attribute [rw] room_arn
1733
+ # The ARN of the room with which the device to sync is associated.
1734
+ # Required.
1735
+ # @return [String]
1736
+ #
1737
+ # @!attribute [rw] device_arn
1738
+ # The ARN of the device to sync. Required.
1739
+ # @return [String]
1740
+ #
1741
+ # @!attribute [rw] features
1742
+ # Request structure to start the device sync. Required.
1743
+ # @return [Array<String>]
1744
+ #
1745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/StartDeviceSyncRequest AWS API Documentation
1746
+ #
1747
+ class StartDeviceSyncRequest < Struct.new(
1748
+ :room_arn,
1749
+ :device_arn,
1750
+ :features)
1751
+ include Aws::Structure
1752
+ end
1753
+
1754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/StartDeviceSyncResponse AWS API Documentation
1755
+ #
1756
+ class StartDeviceSyncResponse < Aws::EmptyStructure; end
1757
+
1758
+ # A key-value pair that can be associated with a resource.
1759
+ #
1760
+ # @note When making an API call, you may pass Tag
1761
+ # data as a hash:
1762
+ #
1763
+ # {
1764
+ # key: "TagKey",
1765
+ # value: "TagValue",
1766
+ # }
1767
+ #
1768
+ # @!attribute [rw] key
1769
+ # The key of a tag. Tag keys are case-sensitive.
1770
+ # @return [String]
1771
+ #
1772
+ # @!attribute [rw] value
1773
+ # The value of a tag. Tag values are case-sensitive and can be null.
1774
+ # @return [String]
1775
+ #
1776
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/Tag AWS API Documentation
1777
+ #
1778
+ class Tag < Struct.new(
1779
+ :key,
1780
+ :value)
1781
+ include Aws::Structure
1782
+ end
1783
+
1784
+ # @note When making an API call, you may pass TagResourceRequest
1785
+ # data as a hash:
1786
+ #
1787
+ # {
1788
+ # arn: "Arn", # required
1789
+ # tags: [ # required
1790
+ # {
1791
+ # key: "TagKey",
1792
+ # value: "TagValue",
1793
+ # },
1794
+ # ],
1795
+ # }
1796
+ #
1797
+ # @!attribute [rw] arn
1798
+ # The ARN of the resource to which to add metadata tags. Required.
1799
+ # @return [String]
1800
+ #
1801
+ # @!attribute [rw] tags
1802
+ # The tags to be added to the specified resource. Do not provide
1803
+ # system tags. Required.
1804
+ # @return [Array<Types::Tag>]
1805
+ #
1806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/TagResourceRequest AWS API Documentation
1807
+ #
1808
+ class TagResourceRequest < Struct.new(
1809
+ :arn,
1810
+ :tags)
1811
+ include Aws::Structure
1812
+ end
1813
+
1814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/TagResourceResponse AWS API Documentation
1815
+ #
1816
+ class TagResourceResponse < Aws::EmptyStructure; end
1817
+
1818
+ # @note When making an API call, you may pass UntagResourceRequest
1819
+ # data as a hash:
1820
+ #
1821
+ # {
1822
+ # arn: "Arn", # required
1823
+ # tag_keys: ["TagKey"], # required
1824
+ # }
1825
+ #
1826
+ # @!attribute [rw] arn
1827
+ # The ARN of the resource from which to remove metadata tags.
1828
+ # Required.
1829
+ # @return [String]
1830
+ #
1831
+ # @!attribute [rw] tag_keys
1832
+ # The tags to be removed from the specified resource. Do not provide
1833
+ # system tags. Required.
1834
+ # @return [Array<String>]
1835
+ #
1836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UntagResourceRequest AWS API Documentation
1837
+ #
1838
+ class UntagResourceRequest < Struct.new(
1839
+ :arn,
1840
+ :tag_keys)
1841
+ include Aws::Structure
1842
+ end
1843
+
1844
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UntagResourceResponse AWS API Documentation
1845
+ #
1846
+ class UntagResourceResponse < Aws::EmptyStructure; end
1847
+
1848
+ # @note When making an API call, you may pass UpdateDeviceRequest
1849
+ # data as a hash:
1850
+ #
1851
+ # {
1852
+ # device_arn: "Arn",
1853
+ # device_name: "DeviceName",
1854
+ # }
1855
+ #
1856
+ # @!attribute [rw] device_arn
1857
+ # The ARN of the device to update. Required.
1858
+ # @return [String]
1859
+ #
1860
+ # @!attribute [rw] device_name
1861
+ # The updated device name. Required.
1862
+ # @return [String]
1863
+ #
1864
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateDeviceRequest AWS API Documentation
1865
+ #
1866
+ class UpdateDeviceRequest < Struct.new(
1867
+ :device_arn,
1868
+ :device_name)
1869
+ include Aws::Structure
1870
+ end
1871
+
1872
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateDeviceResponse AWS API Documentation
1873
+ #
1874
+ class UpdateDeviceResponse < Aws::EmptyStructure; end
1875
+
1876
+ # @note When making an API call, you may pass UpdateProfileRequest
1877
+ # data as a hash:
1878
+ #
1879
+ # {
1880
+ # profile_arn: "Arn",
1881
+ # profile_name: "ProfileName",
1882
+ # timezone: "Timezone",
1883
+ # address: "Address",
1884
+ # distance_unit: "METRIC", # accepts METRIC, IMPERIAL
1885
+ # temperature_unit: "FAHRENHEIT", # accepts FAHRENHEIT, CELSIUS
1886
+ # wake_word: "ALEXA", # accepts ALEXA, AMAZON, ECHO, COMPUTER
1887
+ # setup_mode_disabled: false,
1888
+ # max_volume_limit: 1,
1889
+ # pstn_enabled: false,
1890
+ # }
1891
+ #
1892
+ # @!attribute [rw] profile_arn
1893
+ # The ARN of the room profile to update. Required.
1894
+ # @return [String]
1895
+ #
1896
+ # @!attribute [rw] profile_name
1897
+ # The updated name for the room profile.
1898
+ # @return [String]
1899
+ #
1900
+ # @!attribute [rw] timezone
1901
+ # The updated timezone for the room profile.
1902
+ # @return [String]
1903
+ #
1904
+ # @!attribute [rw] address
1905
+ # The updated address for the room profile.
1906
+ # @return [String]
1907
+ #
1908
+ # @!attribute [rw] distance_unit
1909
+ # The updated distance unit for the room profile.
1910
+ # @return [String]
1911
+ #
1912
+ # @!attribute [rw] temperature_unit
1913
+ # The updated temperature unit for the room profile.
1914
+ # @return [String]
1915
+ #
1916
+ # @!attribute [rw] wake_word
1917
+ # The updated wake word for the room profile.
1918
+ # @return [String]
1919
+ #
1920
+ # @!attribute [rw] setup_mode_disabled
1921
+ # Whether the setup mode of the profile is enabled.
1922
+ # @return [Boolean]
1923
+ #
1924
+ # @!attribute [rw] max_volume_limit
1925
+ # The updated maximum volume limit for the room profile.
1926
+ # @return [Integer]
1927
+ #
1928
+ # @!attribute [rw] pstn_enabled
1929
+ # Whether the PSTN setting of the room profile is enabled.
1930
+ # @return [Boolean]
1931
+ #
1932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateProfileRequest AWS API Documentation
1933
+ #
1934
+ class UpdateProfileRequest < Struct.new(
1935
+ :profile_arn,
1936
+ :profile_name,
1937
+ :timezone,
1938
+ :address,
1939
+ :distance_unit,
1940
+ :temperature_unit,
1941
+ :wake_word,
1942
+ :setup_mode_disabled,
1943
+ :max_volume_limit,
1944
+ :pstn_enabled)
1945
+ include Aws::Structure
1946
+ end
1947
+
1948
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateProfileResponse AWS API Documentation
1949
+ #
1950
+ class UpdateProfileResponse < Aws::EmptyStructure; end
1951
+
1952
+ # @note When making an API call, you may pass UpdateRoomRequest
1953
+ # data as a hash:
1954
+ #
1955
+ # {
1956
+ # room_arn: "Arn",
1957
+ # room_name: "RoomName",
1958
+ # description: "RoomDescription",
1959
+ # provider_calendar_id: "ProviderCalendarId",
1960
+ # profile_arn: "Arn",
1961
+ # }
1962
+ #
1963
+ # @!attribute [rw] room_arn
1964
+ # The ARN of the room to update.
1965
+ # @return [String]
1966
+ #
1967
+ # @!attribute [rw] room_name
1968
+ # The updated name for the room.
1969
+ # @return [String]
1970
+ #
1971
+ # @!attribute [rw] description
1972
+ # The updated description for the room.
1973
+ # @return [String]
1974
+ #
1975
+ # @!attribute [rw] provider_calendar_id
1976
+ # The updated provider calendar ARN for the room.
1977
+ # @return [String]
1978
+ #
1979
+ # @!attribute [rw] profile_arn
1980
+ # The updated profile ARN for the room.
1981
+ # @return [String]
1982
+ #
1983
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateRoomRequest AWS API Documentation
1984
+ #
1985
+ class UpdateRoomRequest < Struct.new(
1986
+ :room_arn,
1987
+ :room_name,
1988
+ :description,
1989
+ :provider_calendar_id,
1990
+ :profile_arn)
1991
+ include Aws::Structure
1992
+ end
1993
+
1994
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateRoomResponse AWS API Documentation
1995
+ #
1996
+ class UpdateRoomResponse < Aws::EmptyStructure; end
1997
+
1998
+ # @note When making an API call, you may pass UpdateSkillGroupRequest
1999
+ # data as a hash:
2000
+ #
2001
+ # {
2002
+ # skill_group_arn: "Arn",
2003
+ # skill_group_name: "SkillGroupName",
2004
+ # description: "SkillGroupDescription",
2005
+ # }
2006
+ #
2007
+ # @!attribute [rw] skill_group_arn
2008
+ # The ARN of the skill group to update.
2009
+ # @return [String]
2010
+ #
2011
+ # @!attribute [rw] skill_group_name
2012
+ # The updated name for the skill group.
2013
+ # @return [String]
2014
+ #
2015
+ # @!attribute [rw] description
2016
+ # The updated description for the skill group.
2017
+ # @return [String]
2018
+ #
2019
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateSkillGroupRequest AWS API Documentation
2020
+ #
2021
+ class UpdateSkillGroupRequest < Struct.new(
2022
+ :skill_group_arn,
2023
+ :skill_group_name,
2024
+ :description)
2025
+ include Aws::Structure
2026
+ end
2027
+
2028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UpdateSkillGroupResponse AWS API Documentation
2029
+ #
2030
+ class UpdateSkillGroupResponse < Aws::EmptyStructure; end
2031
+
2032
+ # Information related to a user.
2033
+ #
2034
+ # @!attribute [rw] user_arn
2035
+ # The ARN of a user.
2036
+ # @return [String]
2037
+ #
2038
+ # @!attribute [rw] first_name
2039
+ # The first name of a user.
2040
+ # @return [String]
2041
+ #
2042
+ # @!attribute [rw] last_name
2043
+ # The last name of a user.
2044
+ # @return [String]
2045
+ #
2046
+ # @!attribute [rw] email
2047
+ # The email of a user.
2048
+ # @return [String]
2049
+ #
2050
+ # @!attribute [rw] enrollment_status
2051
+ # The enrollment status of a user.
2052
+ # @return [String]
2053
+ #
2054
+ # @!attribute [rw] enrollment_id
2055
+ # The enrollment ARN of a user.
2056
+ # @return [String]
2057
+ #
2058
+ # @see http://docs.aws.amazon.com/goto/WebAPI/alexaforbusiness-2017-11-09/UserData AWS API Documentation
2059
+ #
2060
+ class UserData < Struct.new(
2061
+ :user_arn,
2062
+ :first_name,
2063
+ :last_name,
2064
+ :email,
2065
+ :enrollment_status,
2066
+ :enrollment_id)
2067
+ include Aws::Structure
2068
+ end
2069
+
2070
+ end
2071
+ end