aws-sdk-chimesdkmeetings 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,990 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::ChimeSDKMeetings
11
+ module Types
12
+
13
+ # An Amazon Chime SDK meeting attendee. Includes a unique `AttendeeId`
14
+ # and `JoinToken`. The `JoinToken` allows a client to authenticate and
15
+ # join as the specified attendee. The `JoinToken` expires when the
16
+ # meeting ends, or when DeleteAttendee is called. After that, the
17
+ # attendee is unable to join the meeting.
18
+ #
19
+ # We recommend securely transferring each `JoinToken` from your server
20
+ # application to the client so that no other client has access to the
21
+ # token except for the one authorized to represent the attendee.
22
+ #
23
+ # @!attribute [rw] external_user_id
24
+ # The Amazon Chime SDK external user ID. An idempotency token. Links
25
+ # the attendee to an identity managed by a builder application.
26
+ # @return [String]
27
+ #
28
+ # @!attribute [rw] attendee_id
29
+ # The Amazon Chime SDK attendee ID.
30
+ # @return [String]
31
+ #
32
+ # @!attribute [rw] join_token
33
+ # The join token used by the Amazon Chime SDK attendee.
34
+ # @return [String]
35
+ #
36
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/Attendee AWS API Documentation
37
+ #
38
+ class Attendee < Struct.new(
39
+ :external_user_id,
40
+ :attendee_id,
41
+ :join_token)
42
+ SENSITIVE = [:external_user_id, :join_token]
43
+ include Aws::Structure
44
+ end
45
+
46
+ # The input parameters don't match the service's restrictions.
47
+ #
48
+ # @!attribute [rw] code
49
+ # @return [String]
50
+ #
51
+ # @!attribute [rw] message
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] request_id
55
+ # The request id associated with the call responsible for the
56
+ # exception.
57
+ # @return [String]
58
+ #
59
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/BadRequestException AWS API Documentation
60
+ #
61
+ class BadRequestException < Struct.new(
62
+ :code,
63
+ :message,
64
+ :request_id)
65
+ SENSITIVE = []
66
+ include Aws::Structure
67
+ end
68
+
69
+ # @note When making an API call, you may pass BatchCreateAttendeeRequest
70
+ # data as a hash:
71
+ #
72
+ # {
73
+ # meeting_id: "String", # required
74
+ # attendees: [ # required
75
+ # {
76
+ # external_user_id: "ExternalUserId", # required
77
+ # },
78
+ # ],
79
+ # }
80
+ #
81
+ # @!attribute [rw] meeting_id
82
+ # The Amazon Chime SDK ID of the meeting to which you're adding
83
+ # attendees.
84
+ # @return [String]
85
+ #
86
+ # @!attribute [rw] attendees
87
+ # The attendee information, including attendees' IDs and join tokens.
88
+ # @return [Array<Types::CreateAttendeeRequestItem>]
89
+ #
90
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/BatchCreateAttendeeRequest AWS API Documentation
91
+ #
92
+ class BatchCreateAttendeeRequest < Struct.new(
93
+ :meeting_id,
94
+ :attendees)
95
+ SENSITIVE = []
96
+ include Aws::Structure
97
+ end
98
+
99
+ # @!attribute [rw] attendees
100
+ # The attendee information, including attendees' IDs and join tokens.
101
+ # @return [Array<Types::Attendee>]
102
+ #
103
+ # @!attribute [rw] errors
104
+ # If the action fails for one or more of the attendees in the request,
105
+ # a list of the attendees is returned, along with error codes and
106
+ # error messages.
107
+ # @return [Array<Types::CreateAttendeeError>]
108
+ #
109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/BatchCreateAttendeeResponse AWS API Documentation
110
+ #
111
+ class BatchCreateAttendeeResponse < Struct.new(
112
+ :attendees,
113
+ :errors)
114
+ SENSITIVE = []
115
+ include Aws::Structure
116
+ end
117
+
118
+ # The list of errors returned when errors are encountered during the
119
+ # BatchCreateAttendee and CreateAttendee actions. This includes external
120
+ # user IDs, error codes, and error messages.
121
+ #
122
+ # @!attribute [rw] external_user_id
123
+ # The Amazon Chime SDK external user ID. An idempotency token. Links
124
+ # the attendee to an identity managed by a builder application.
125
+ # @return [String]
126
+ #
127
+ # @!attribute [rw] error_code
128
+ # The error code.
129
+ # @return [String]
130
+ #
131
+ # @!attribute [rw] error_message
132
+ # The error message.
133
+ # @return [String]
134
+ #
135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateAttendeeError AWS API Documentation
136
+ #
137
+ class CreateAttendeeError < Struct.new(
138
+ :external_user_id,
139
+ :error_code,
140
+ :error_message)
141
+ SENSITIVE = [:external_user_id]
142
+ include Aws::Structure
143
+ end
144
+
145
+ # @note When making an API call, you may pass CreateAttendeeRequest
146
+ # data as a hash:
147
+ #
148
+ # {
149
+ # meeting_id: "String", # required
150
+ # external_user_id: "ExternalUserId", # required
151
+ # }
152
+ #
153
+ # @!attribute [rw] meeting_id
154
+ # The unique ID of the meeting.
155
+ # @return [String]
156
+ #
157
+ # @!attribute [rw] external_user_id
158
+ # The Amazon Chime SDK external user ID. An idempotency token. Links
159
+ # the attendee to an identity managed by a builder application.
160
+ # @return [String]
161
+ #
162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateAttendeeRequest AWS API Documentation
163
+ #
164
+ class CreateAttendeeRequest < Struct.new(
165
+ :meeting_id,
166
+ :external_user_id)
167
+ SENSITIVE = [:external_user_id]
168
+ include Aws::Structure
169
+ end
170
+
171
+ # The Amazon Chime SDK attendee fields to create, used with the
172
+ # BatchCreateAttendee action.
173
+ #
174
+ # @note When making an API call, you may pass CreateAttendeeRequestItem
175
+ # data as a hash:
176
+ #
177
+ # {
178
+ # external_user_id: "ExternalUserId", # required
179
+ # }
180
+ #
181
+ # @!attribute [rw] external_user_id
182
+ # The Amazon Chime SDK external user ID. An idempotency token. Links
183
+ # the attendee to an identity managed by a builder application.
184
+ # @return [String]
185
+ #
186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateAttendeeRequestItem AWS API Documentation
187
+ #
188
+ class CreateAttendeeRequestItem < Struct.new(
189
+ :external_user_id)
190
+ SENSITIVE = [:external_user_id]
191
+ include Aws::Structure
192
+ end
193
+
194
+ # @!attribute [rw] attendee
195
+ # The attendee information, including attendee ID and join token.
196
+ # @return [Types::Attendee]
197
+ #
198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateAttendeeResponse AWS API Documentation
199
+ #
200
+ class CreateAttendeeResponse < Struct.new(
201
+ :attendee)
202
+ SENSITIVE = []
203
+ include Aws::Structure
204
+ end
205
+
206
+ # @note When making an API call, you may pass CreateMeetingRequest
207
+ # data as a hash:
208
+ #
209
+ # {
210
+ # client_request_token: "ClientRequestToken", # required
211
+ # media_region: "String", # required
212
+ # meeting_host_id: "ExternalUserId",
213
+ # external_meeting_id: "ExternalMeetingId", # required
214
+ # notifications_configuration: {
215
+ # lambda_function_arn: "Arn",
216
+ # sns_topic_arn: "Arn",
217
+ # sqs_queue_arn: "Arn",
218
+ # },
219
+ # }
220
+ #
221
+ # @!attribute [rw] client_request_token
222
+ # The unique identifier for the client request. Use a different token
223
+ # for different meetings.
224
+ #
225
+ # **A suitable default value is auto-generated.** You should normally
226
+ # not need to pass this option.
227
+ # @return [String]
228
+ #
229
+ # @!attribute [rw] media_region
230
+ # The Region in which to create the meeting. Default: `us-east-1`.
231
+ #
232
+ # Available values: `af-south-1` , `ap-northeast-1` , `ap-northeast-2`
233
+ # , `ap-south-1` , `ap-southeast-1` , `ap-southeast-2` ,
234
+ # `ca-central-1` , `eu-central-1` , `eu-north-1` , `eu-south-1` ,
235
+ # `eu-west-1` , `eu-west-2` , `eu-west-3` , `sa-east-1` , `us-east-1`
236
+ # , `us-east-2` , `us-west-1` , `us-west-2` .
237
+ # @return [String]
238
+ #
239
+ # @!attribute [rw] meeting_host_id
240
+ # Reserved.
241
+ # @return [String]
242
+ #
243
+ # @!attribute [rw] external_meeting_id
244
+ # The external meeting ID.
245
+ # @return [String]
246
+ #
247
+ # @!attribute [rw] notifications_configuration
248
+ # The configuration for resource targets to receive notifications when
249
+ # meeting and attendee events occur.
250
+ # @return [Types::NotificationsConfiguration]
251
+ #
252
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateMeetingRequest AWS API Documentation
253
+ #
254
+ class CreateMeetingRequest < Struct.new(
255
+ :client_request_token,
256
+ :media_region,
257
+ :meeting_host_id,
258
+ :external_meeting_id,
259
+ :notifications_configuration)
260
+ SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
261
+ include Aws::Structure
262
+ end
263
+
264
+ # @!attribute [rw] meeting
265
+ # The meeting information, including the meeting ID and
266
+ # `MediaPlacement`.
267
+ # @return [Types::Meeting]
268
+ #
269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateMeetingResponse AWS API Documentation
270
+ #
271
+ class CreateMeetingResponse < Struct.new(
272
+ :meeting)
273
+ SENSITIVE = []
274
+ include Aws::Structure
275
+ end
276
+
277
+ # @note When making an API call, you may pass CreateMeetingWithAttendeesRequest
278
+ # data as a hash:
279
+ #
280
+ # {
281
+ # client_request_token: "ClientRequestToken", # required
282
+ # media_region: "String", # required
283
+ # meeting_host_id: "ExternalUserId",
284
+ # external_meeting_id: "ExternalMeetingId", # required
285
+ # notifications_configuration: {
286
+ # lambda_function_arn: "Arn",
287
+ # sns_topic_arn: "Arn",
288
+ # sqs_queue_arn: "Arn",
289
+ # },
290
+ # attendees: [ # required
291
+ # {
292
+ # external_user_id: "ExternalUserId", # required
293
+ # },
294
+ # ],
295
+ # }
296
+ #
297
+ # @!attribute [rw] client_request_token
298
+ # The unique identifier for the client request. Use a different token
299
+ # for different meetings.
300
+ #
301
+ # **A suitable default value is auto-generated.** You should normally
302
+ # not need to pass this option.
303
+ # @return [String]
304
+ #
305
+ # @!attribute [rw] media_region
306
+ # The Region in which to create the meeting. Default: `us-east-1`.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] meeting_host_id
310
+ # Reserved.
311
+ # @return [String]
312
+ #
313
+ # @!attribute [rw] external_meeting_id
314
+ # The external meeting ID.
315
+ # @return [String]
316
+ #
317
+ # @!attribute [rw] notifications_configuration
318
+ # The configuration for resource targets to receive notifications when
319
+ # meeting and attendee events occur.
320
+ # @return [Types::NotificationsConfiguration]
321
+ #
322
+ # @!attribute [rw] attendees
323
+ # The attendee information, including attendees' IDs and join tokens.
324
+ # @return [Array<Types::CreateAttendeeRequestItem>]
325
+ #
326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateMeetingWithAttendeesRequest AWS API Documentation
327
+ #
328
+ class CreateMeetingWithAttendeesRequest < Struct.new(
329
+ :client_request_token,
330
+ :media_region,
331
+ :meeting_host_id,
332
+ :external_meeting_id,
333
+ :notifications_configuration,
334
+ :attendees)
335
+ SENSITIVE = [:client_request_token, :meeting_host_id, :external_meeting_id]
336
+ include Aws::Structure
337
+ end
338
+
339
+ # @!attribute [rw] meeting
340
+ # The meeting information, including the meeting ID and
341
+ # `MediaPlacement`.
342
+ # @return [Types::Meeting]
343
+ #
344
+ # @!attribute [rw] attendees
345
+ # The attendee information, including attendees' IDs and join tokens.
346
+ # @return [Array<Types::Attendee>]
347
+ #
348
+ # @!attribute [rw] errors
349
+ # If the action fails for one or more of the attendees in the request,
350
+ # a list of the attendees is returned, along with error codes and
351
+ # error messages.
352
+ # @return [Array<Types::CreateAttendeeError>]
353
+ #
354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/CreateMeetingWithAttendeesResponse AWS API Documentation
355
+ #
356
+ class CreateMeetingWithAttendeesResponse < Struct.new(
357
+ :meeting,
358
+ :attendees,
359
+ :errors)
360
+ SENSITIVE = []
361
+ include Aws::Structure
362
+ end
363
+
364
+ # @note When making an API call, you may pass DeleteAttendeeRequest
365
+ # data as a hash:
366
+ #
367
+ # {
368
+ # meeting_id: "String", # required
369
+ # attendee_id: "String", # required
370
+ # }
371
+ #
372
+ # @!attribute [rw] meeting_id
373
+ # The Amazon Chime SDK meeting ID.
374
+ # @return [String]
375
+ #
376
+ # @!attribute [rw] attendee_id
377
+ # The Amazon Chime SDK attendee ID.
378
+ # @return [String]
379
+ #
380
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/DeleteAttendeeRequest AWS API Documentation
381
+ #
382
+ class DeleteAttendeeRequest < Struct.new(
383
+ :meeting_id,
384
+ :attendee_id)
385
+ SENSITIVE = []
386
+ include Aws::Structure
387
+ end
388
+
389
+ # @note When making an API call, you may pass DeleteMeetingRequest
390
+ # data as a hash:
391
+ #
392
+ # {
393
+ # meeting_id: "String", # required
394
+ # }
395
+ #
396
+ # @!attribute [rw] meeting_id
397
+ # The Amazon Chime SDK meeting ID.
398
+ # @return [String]
399
+ #
400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/DeleteMeetingRequest AWS API Documentation
401
+ #
402
+ class DeleteMeetingRequest < Struct.new(
403
+ :meeting_id)
404
+ SENSITIVE = []
405
+ include Aws::Structure
406
+ end
407
+
408
+ # Settings specific to the Amazon Transcribe Medical engine.
409
+ #
410
+ # @note When making an API call, you may pass EngineTranscribeMedicalSettings
411
+ # data as a hash:
412
+ #
413
+ # {
414
+ # language_code: "en-US", # required, accepts en-US
415
+ # specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE, CARDIOLOGY, NEUROLOGY, ONCOLOGY, RADIOLOGY, UROLOGY
416
+ # type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
417
+ # vocabulary_name: "String",
418
+ # region: "us-east-1", # accepts us-east-1, us-east-2, us-west-2, ap-southeast-2, ca-central-1, eu-west-1, auto
419
+ # }
420
+ #
421
+ # @!attribute [rw] language_code
422
+ # The language code specified for the Amazon Transcribe Medical
423
+ # engine.
424
+ # @return [String]
425
+ #
426
+ # @!attribute [rw] specialty
427
+ # The specialty specified for the Amazon Transcribe Medical engine.
428
+ # @return [String]
429
+ #
430
+ # @!attribute [rw] type
431
+ # The type of transcription.
432
+ # @return [String]
433
+ #
434
+ # @!attribute [rw] vocabulary_name
435
+ # The name of the vocabulary passed to Amazon Transcribe Medical.
436
+ # @return [String]
437
+ #
438
+ # @!attribute [rw] region
439
+ # The AWS Region passed to Amazon Transcribe Medical. If you don't
440
+ # specify a Region, Amazon Chime uses the meeting's Region.
441
+ # @return [String]
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/EngineTranscribeMedicalSettings AWS API Documentation
444
+ #
445
+ class EngineTranscribeMedicalSettings < Struct.new(
446
+ :language_code,
447
+ :specialty,
448
+ :type,
449
+ :vocabulary_name,
450
+ :region)
451
+ SENSITIVE = []
452
+ include Aws::Structure
453
+ end
454
+
455
+ # Settings specific to the Amazon Transcribe engine.
456
+ #
457
+ # @note When making an API call, you may pass EngineTranscribeSettings
458
+ # data as a hash:
459
+ #
460
+ # {
461
+ # language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
462
+ # vocabulary_filter_method: "remove", # accepts remove, mask, tag
463
+ # vocabulary_filter_name: "String",
464
+ # vocabulary_name: "String",
465
+ # region: "us-east-2", # accepts us-east-2, us-east-1, us-west-2, ap-northeast-2, ap-southeast-2, ap-northeast-1, ca-central-1, eu-central-1, eu-west-1, eu-west-2, sa-east-1, auto
466
+ # }
467
+ #
468
+ # @!attribute [rw] language_code
469
+ # The language code specified for the Amazon Transcribe engine.
470
+ # @return [String]
471
+ #
472
+ # @!attribute [rw] vocabulary_filter_method
473
+ # The filtering method passed to Amazon Transcribe.
474
+ # @return [String]
475
+ #
476
+ # @!attribute [rw] vocabulary_filter_name
477
+ # The name of the vocabulary filter passed to Amazon Transcribe.
478
+ # @return [String]
479
+ #
480
+ # @!attribute [rw] vocabulary_name
481
+ # The name of the vocabulary passed to Amazon Transcribe.
482
+ # @return [String]
483
+ #
484
+ # @!attribute [rw] region
485
+ # The AWS Region passed to Amazon Transcribe. If you don't specify a
486
+ # Region, Amazon Chime uses the meeting's Region.
487
+ # @return [String]
488
+ #
489
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/EngineTranscribeSettings AWS API Documentation
490
+ #
491
+ class EngineTranscribeSettings < Struct.new(
492
+ :language_code,
493
+ :vocabulary_filter_method,
494
+ :vocabulary_filter_name,
495
+ :vocabulary_name,
496
+ :region)
497
+ SENSITIVE = []
498
+ include Aws::Structure
499
+ end
500
+
501
+ # The client is permanently forbidden from making the request.
502
+ #
503
+ # @!attribute [rw] code
504
+ # @return [String]
505
+ #
506
+ # @!attribute [rw] message
507
+ # @return [String]
508
+ #
509
+ # @!attribute [rw] request_id
510
+ # The request id associated with the call responsible for the
511
+ # exception.
512
+ # @return [String]
513
+ #
514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/ForbiddenException AWS API Documentation
515
+ #
516
+ class ForbiddenException < Struct.new(
517
+ :code,
518
+ :message,
519
+ :request_id)
520
+ SENSITIVE = []
521
+ include Aws::Structure
522
+ end
523
+
524
+ # @note When making an API call, you may pass GetAttendeeRequest
525
+ # data as a hash:
526
+ #
527
+ # {
528
+ # meeting_id: "String", # required
529
+ # attendee_id: "String", # required
530
+ # }
531
+ #
532
+ # @!attribute [rw] meeting_id
533
+ # The Amazon Chime SDK meeting ID.
534
+ # @return [String]
535
+ #
536
+ # @!attribute [rw] attendee_id
537
+ # The Amazon Chime SDK attendee ID.
538
+ # @return [String]
539
+ #
540
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/GetAttendeeRequest AWS API Documentation
541
+ #
542
+ class GetAttendeeRequest < Struct.new(
543
+ :meeting_id,
544
+ :attendee_id)
545
+ SENSITIVE = []
546
+ include Aws::Structure
547
+ end
548
+
549
+ # @!attribute [rw] attendee
550
+ # The Amazon Chime SDK attendee information.
551
+ # @return [Types::Attendee]
552
+ #
553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/GetAttendeeResponse AWS API Documentation
554
+ #
555
+ class GetAttendeeResponse < Struct.new(
556
+ :attendee)
557
+ SENSITIVE = []
558
+ include Aws::Structure
559
+ end
560
+
561
+ # @note When making an API call, you may pass GetMeetingRequest
562
+ # data as a hash:
563
+ #
564
+ # {
565
+ # meeting_id: "String", # required
566
+ # }
567
+ #
568
+ # @!attribute [rw] meeting_id
569
+ # The Amazon Chime SDK meeting ID.
570
+ # @return [String]
571
+ #
572
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/GetMeetingRequest AWS API Documentation
573
+ #
574
+ class GetMeetingRequest < Struct.new(
575
+ :meeting_id)
576
+ SENSITIVE = []
577
+ include Aws::Structure
578
+ end
579
+
580
+ # @!attribute [rw] meeting
581
+ # The Amazon Chime SDK meeting information.
582
+ # @return [Types::Meeting]
583
+ #
584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/GetMeetingResponse AWS API Documentation
585
+ #
586
+ class GetMeetingResponse < Struct.new(
587
+ :meeting)
588
+ SENSITIVE = []
589
+ include Aws::Structure
590
+ end
591
+
592
+ # The request exceeds the resource limit.
593
+ #
594
+ # @!attribute [rw] code
595
+ # @return [String]
596
+ #
597
+ # @!attribute [rw] message
598
+ # @return [String]
599
+ #
600
+ # @!attribute [rw] request_id
601
+ # The request id associated with the call responsible for the
602
+ # exception.
603
+ # @return [String]
604
+ #
605
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/LimitExceededException AWS API Documentation
606
+ #
607
+ class LimitExceededException < Struct.new(
608
+ :code,
609
+ :message,
610
+ :request_id)
611
+ SENSITIVE = []
612
+ include Aws::Structure
613
+ end
614
+
615
+ # @note When making an API call, you may pass ListAttendeesRequest
616
+ # data as a hash:
617
+ #
618
+ # {
619
+ # meeting_id: "String", # required
620
+ # next_token: "String",
621
+ # max_results: 1,
622
+ # }
623
+ #
624
+ # @!attribute [rw] meeting_id
625
+ # The Amazon Chime SDK meeting ID.
626
+ # @return [String]
627
+ #
628
+ # @!attribute [rw] next_token
629
+ # The token to use to retrieve the next page of results.
630
+ # @return [String]
631
+ #
632
+ # @!attribute [rw] max_results
633
+ # The maximum number of results to return in a single call.
634
+ # @return [Integer]
635
+ #
636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/ListAttendeesRequest AWS API Documentation
637
+ #
638
+ class ListAttendeesRequest < Struct.new(
639
+ :meeting_id,
640
+ :next_token,
641
+ :max_results)
642
+ SENSITIVE = []
643
+ include Aws::Structure
644
+ end
645
+
646
+ # @!attribute [rw] attendees
647
+ # The Amazon Chime SDK attendee information.
648
+ # @return [Array<Types::Attendee>]
649
+ #
650
+ # @!attribute [rw] next_token
651
+ # The token to use to retrieve the next page of results.
652
+ # @return [String]
653
+ #
654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/ListAttendeesResponse AWS API Documentation
655
+ #
656
+ class ListAttendeesResponse < Struct.new(
657
+ :attendees,
658
+ :next_token)
659
+ SENSITIVE = []
660
+ include Aws::Structure
661
+ end
662
+
663
+ # A set of endpoints used by clients to connect to the media service
664
+ # group for an Amazon Chime SDK meeting.
665
+ #
666
+ # @!attribute [rw] audio_host_url
667
+ # The audio host URL.
668
+ # @return [String]
669
+ #
670
+ # @!attribute [rw] audio_fallback_url
671
+ # The audio fallback URL.
672
+ # @return [String]
673
+ #
674
+ # @!attribute [rw] signaling_url
675
+ # The signaling URL.
676
+ # @return [String]
677
+ #
678
+ # @!attribute [rw] turn_control_url
679
+ # The turn control URL.
680
+ # @return [String]
681
+ #
682
+ # @!attribute [rw] screen_data_url
683
+ # The screen data URL.
684
+ # @return [String]
685
+ #
686
+ # @!attribute [rw] screen_viewing_url
687
+ # The screen viewing URL.
688
+ # @return [String]
689
+ #
690
+ # @!attribute [rw] screen_sharing_url
691
+ # The screen sharing URL.
692
+ # @return [String]
693
+ #
694
+ # @!attribute [rw] event_ingestion_url
695
+ # The event ingestion URL.
696
+ # @return [String]
697
+ #
698
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/MediaPlacement AWS API Documentation
699
+ #
700
+ class MediaPlacement < Struct.new(
701
+ :audio_host_url,
702
+ :audio_fallback_url,
703
+ :signaling_url,
704
+ :turn_control_url,
705
+ :screen_data_url,
706
+ :screen_viewing_url,
707
+ :screen_sharing_url,
708
+ :event_ingestion_url)
709
+ SENSITIVE = []
710
+ include Aws::Structure
711
+ end
712
+
713
+ # A meeting created using the Amazon Chime SDK.
714
+ #
715
+ # @!attribute [rw] meeting_id
716
+ # The Amazon Chime SDK meeting ID.
717
+ # @return [String]
718
+ #
719
+ # @!attribute [rw] meeting_host_id
720
+ # Reserved.
721
+ # @return [String]
722
+ #
723
+ # @!attribute [rw] external_meeting_id
724
+ # The external meeting ID.
725
+ # @return [String]
726
+ #
727
+ # @!attribute [rw] media_region
728
+ # The Region in which you create the meeting. Available values:
729
+ # `af-south-1`, `ap-northeast-1`, `ap-northeast-2`, `ap-south-1`,
730
+ # `ap-southeast-1`, `ap-southeast-2`, `ca-central-1`, `eu-central-1`,
731
+ # `eu-north-1`, `eu-south-1`, `eu-west-1`, `eu-west-2`, `eu-west-3`,
732
+ # `sa-east-1`, `us-east-1`, `us-east-2`, `us-west-1`, `us-west-2`.
733
+ # @return [String]
734
+ #
735
+ # @!attribute [rw] media_placement
736
+ # The media placement for the meeting.
737
+ # @return [Types::MediaPlacement]
738
+ #
739
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/Meeting AWS API Documentation
740
+ #
741
+ class Meeting < Struct.new(
742
+ :meeting_id,
743
+ :meeting_host_id,
744
+ :external_meeting_id,
745
+ :media_region,
746
+ :media_placement)
747
+ SENSITIVE = [:meeting_host_id, :external_meeting_id]
748
+ include Aws::Structure
749
+ end
750
+
751
+ # One or more of the resources in the request does not exist in the
752
+ # system.
753
+ #
754
+ # @!attribute [rw] code
755
+ # @return [String]
756
+ #
757
+ # @!attribute [rw] message
758
+ # @return [String]
759
+ #
760
+ # @!attribute [rw] request_id
761
+ # The request id associated with the call responsible for the
762
+ # exception.
763
+ # @return [String]
764
+ #
765
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/NotFoundException AWS API Documentation
766
+ #
767
+ class NotFoundException < Struct.new(
768
+ :code,
769
+ :message,
770
+ :request_id)
771
+ SENSITIVE = []
772
+ include Aws::Structure
773
+ end
774
+
775
+ # The configuration for resource targets to receive notifications when
776
+ # meeting and attendee events occur.
777
+ #
778
+ # @note When making an API call, you may pass NotificationsConfiguration
779
+ # data as a hash:
780
+ #
781
+ # {
782
+ # lambda_function_arn: "Arn",
783
+ # sns_topic_arn: "Arn",
784
+ # sqs_queue_arn: "Arn",
785
+ # }
786
+ #
787
+ # @!attribute [rw] lambda_function_arn
788
+ # The ARN of the AWS Lambda function in the notifications
789
+ # configuration.
790
+ # @return [String]
791
+ #
792
+ # @!attribute [rw] sns_topic_arn
793
+ # The ARN of the SNS topic.
794
+ # @return [String]
795
+ #
796
+ # @!attribute [rw] sqs_queue_arn
797
+ # The ARN of the SQS queue.
798
+ # @return [String]
799
+ #
800
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/NotificationsConfiguration AWS API Documentation
801
+ #
802
+ class NotificationsConfiguration < Struct.new(
803
+ :lambda_function_arn,
804
+ :sns_topic_arn,
805
+ :sqs_queue_arn)
806
+ SENSITIVE = [:lambda_function_arn, :sns_topic_arn, :sqs_queue_arn]
807
+ include Aws::Structure
808
+ end
809
+
810
+ # The service is currently unavailable.
811
+ #
812
+ # @!attribute [rw] code
813
+ # @return [String]
814
+ #
815
+ # @!attribute [rw] message
816
+ # @return [String]
817
+ #
818
+ # @!attribute [rw] request_id
819
+ # The request id associated with the call responsible for the
820
+ # exception.
821
+ # @return [String]
822
+ #
823
+ # @!attribute [rw] retry_after_seconds
824
+ # The number of seconds the caller should wait before retrying.
825
+ # @return [String]
826
+ #
827
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/ServiceUnavailableException AWS API Documentation
828
+ #
829
+ class ServiceUnavailableException < Struct.new(
830
+ :code,
831
+ :message,
832
+ :request_id,
833
+ :retry_after_seconds)
834
+ SENSITIVE = []
835
+ include Aws::Structure
836
+ end
837
+
838
+ # @note When making an API call, you may pass StartMeetingTranscriptionRequest
839
+ # data as a hash:
840
+ #
841
+ # {
842
+ # meeting_id: "String", # required
843
+ # transcription_configuration: { # required
844
+ # engine_transcribe_settings: {
845
+ # language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
846
+ # vocabulary_filter_method: "remove", # accepts remove, mask, tag
847
+ # vocabulary_filter_name: "String",
848
+ # vocabulary_name: "String",
849
+ # region: "us-east-2", # accepts us-east-2, us-east-1, us-west-2, ap-northeast-2, ap-southeast-2, ap-northeast-1, ca-central-1, eu-central-1, eu-west-1, eu-west-2, sa-east-1, auto
850
+ # },
851
+ # engine_transcribe_medical_settings: {
852
+ # language_code: "en-US", # required, accepts en-US
853
+ # specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE, CARDIOLOGY, NEUROLOGY, ONCOLOGY, RADIOLOGY, UROLOGY
854
+ # type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
855
+ # vocabulary_name: "String",
856
+ # region: "us-east-1", # accepts us-east-1, us-east-2, us-west-2, ap-southeast-2, ca-central-1, eu-west-1, auto
857
+ # },
858
+ # },
859
+ # }
860
+ #
861
+ # @!attribute [rw] meeting_id
862
+ # The unique ID of the meeting being transcribed.
863
+ # @return [String]
864
+ #
865
+ # @!attribute [rw] transcription_configuration
866
+ # The configuration for the current transcription operation. Must
867
+ # contain `EngineTranscribeSettings` or
868
+ # `EngineTranscribeMedicalSettings`.
869
+ # @return [Types::TranscriptionConfiguration]
870
+ #
871
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/StartMeetingTranscriptionRequest AWS API Documentation
872
+ #
873
+ class StartMeetingTranscriptionRequest < Struct.new(
874
+ :meeting_id,
875
+ :transcription_configuration)
876
+ SENSITIVE = []
877
+ include Aws::Structure
878
+ end
879
+
880
+ # @note When making an API call, you may pass StopMeetingTranscriptionRequest
881
+ # data as a hash:
882
+ #
883
+ # {
884
+ # meeting_id: "String", # required
885
+ # }
886
+ #
887
+ # @!attribute [rw] meeting_id
888
+ # The unique ID of the meeting for which you stop transcription.
889
+ # @return [String]
890
+ #
891
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/StopMeetingTranscriptionRequest AWS API Documentation
892
+ #
893
+ class StopMeetingTranscriptionRequest < Struct.new(
894
+ :meeting_id)
895
+ SENSITIVE = []
896
+ include Aws::Structure
897
+ end
898
+
899
+ # The configuration for the current transcription operation. Must
900
+ # contain `EngineTranscribeSettings` or
901
+ # `EngineTranscribeMedicalSettings`.
902
+ #
903
+ # @note When making an API call, you may pass TranscriptionConfiguration
904
+ # data as a hash:
905
+ #
906
+ # {
907
+ # engine_transcribe_settings: {
908
+ # language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
909
+ # vocabulary_filter_method: "remove", # accepts remove, mask, tag
910
+ # vocabulary_filter_name: "String",
911
+ # vocabulary_name: "String",
912
+ # region: "us-east-2", # accepts us-east-2, us-east-1, us-west-2, ap-northeast-2, ap-southeast-2, ap-northeast-1, ca-central-1, eu-central-1, eu-west-1, eu-west-2, sa-east-1, auto
913
+ # },
914
+ # engine_transcribe_medical_settings: {
915
+ # language_code: "en-US", # required, accepts en-US
916
+ # specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE, CARDIOLOGY, NEUROLOGY, ONCOLOGY, RADIOLOGY, UROLOGY
917
+ # type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
918
+ # vocabulary_name: "String",
919
+ # region: "us-east-1", # accepts us-east-1, us-east-2, us-west-2, ap-southeast-2, ca-central-1, eu-west-1, auto
920
+ # },
921
+ # }
922
+ #
923
+ # @!attribute [rw] engine_transcribe_settings
924
+ # The transcription configuration settings passed to Amazon
925
+ # Transcribe.
926
+ # @return [Types::EngineTranscribeSettings]
927
+ #
928
+ # @!attribute [rw] engine_transcribe_medical_settings
929
+ # The transcription configuration settings passed to Amazon Transcribe
930
+ # Medical.
931
+ # @return [Types::EngineTranscribeMedicalSettings]
932
+ #
933
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/TranscriptionConfiguration AWS API Documentation
934
+ #
935
+ class TranscriptionConfiguration < Struct.new(
936
+ :engine_transcribe_settings,
937
+ :engine_transcribe_medical_settings)
938
+ SENSITIVE = []
939
+ include Aws::Structure
940
+ end
941
+
942
+ # The user isn't authorized to request a resource.
943
+ #
944
+ # @!attribute [rw] code
945
+ # @return [String]
946
+ #
947
+ # @!attribute [rw] message
948
+ # @return [String]
949
+ #
950
+ # @!attribute [rw] request_id
951
+ # The request id associated with the call responsible for the
952
+ # exception.
953
+ # @return [String]
954
+ #
955
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/UnauthorizedException AWS API Documentation
956
+ #
957
+ class UnauthorizedException < Struct.new(
958
+ :code,
959
+ :message,
960
+ :request_id)
961
+ SENSITIVE = []
962
+ include Aws::Structure
963
+ end
964
+
965
+ # The request was well-formed but was unable to be followed due to
966
+ # semantic errors.
967
+ #
968
+ # @!attribute [rw] code
969
+ # @return [String]
970
+ #
971
+ # @!attribute [rw] message
972
+ # @return [String]
973
+ #
974
+ # @!attribute [rw] request_id
975
+ # The request id associated with the call responsible for the
976
+ # exception.
977
+ # @return [String]
978
+ #
979
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15/UnprocessableEntityException AWS API Documentation
980
+ #
981
+ class UnprocessableEntityException < Struct.new(
982
+ :code,
983
+ :message,
984
+ :request_id)
985
+ SENSITIVE = []
986
+ include Aws::Structure
987
+ end
988
+
989
+ end
990
+ end