/
docs-2.json
561 lines (561 loc) · 37.8 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
{
"version": "2.0",
"service": "<p>The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Meetings.html\">Amazon Chime SDK meetings</a>.</p>",
"operations": {
"BatchCreateAttendee": "<p>Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>.</p>",
"BatchUpdateAttendeeCapabilitiesExcept": "<p>Updates <code>AttendeeCapabilities</code> except the capabilities listed in an <code>ExcludedAttendeeIds</code> table.</p> <note> <p>You use the capabilities with a set of values that control what the capabilities can do, such as <code>SendReceive</code> data. For more information about those values, see .</p> </note> <p>When using capabilities, be aware of these corner cases:</p> <ul> <li> <p>You can't set <code>content</code> capabilities to <code>SendReceive</code> or <code>Receive</code> unless you also set <code>video</code> capabilities to <code>SendReceive</code> or <code>Receive</code>. If you don't set the <code>video</code> capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your <code>video</code> capability to receive and you set your <code>content</code> capability to not receive.</p> </li> <li> <p>When you change an <code>audio</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.</p> </li> <li> <p>When you change a <code>video</code> or <code>content</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.</p> </li> </ul>",
"CreateAttendee": "<p> Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </p>",
"CreateMeeting": "<p>Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html\">Amazon Chime SDK Media Regions</a> in the <i>Amazon Chime Developer Guide</i>. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </p>",
"CreateMeetingWithAttendees": "<p> Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html\">Amazon Chime SDK Media Regions</a> in the <i>Amazon Chime Developer Guide</i>. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </p>",
"DeleteAttendee": "<p>Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their <code>JoinToken</code>. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>.</p>",
"DeleteMeeting": "<p>Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>.</p>",
"GetAttendee": "<p> Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </p>",
"GetMeeting": "<p>Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>.</p>",
"ListAttendees": "<p> Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </p>",
"StartMeetingTranscription": "<p>Starts transcription for the specified <code>meetingId</code>.</p>",
"StopMeetingTranscription": "<p>Stops transcription for the specified <code>meetingId</code>.</p>",
"UpdateAttendeeCapabilities": "<p>The capabilties that you want to update.</p> <note> <p>You use the capabilities with a set of values that control what the capabilities can do, such as <code>SendReceive</code> data. For more information about those values, see .</p> </note> <p>When using capabilities, be aware of these corner cases:</p> <ul> <li> <p>You can't set <code>content</code> capabilities to <code>SendReceive</code> or <code>Receive</code> unless you also set <code>video</code> capabilities to <code>SendReceive</code> or <code>Receive</code>. If you don't set the <code>video</code> capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your <code>video</code> capability to receive and you set your <code>content</code> capability to not receive.</p> </li> <li> <p>When you change an <code>audio</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.</p> </li> <li> <p>When you change a <code>video</code> or <code>content</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.</p> </li> </ul>"
},
"shapes": {
"Arn": {
"base": null,
"refs": {
"NotificationsConfiguration$LambdaFunctionArn": "<p>The ARN of the AWS Lambda function in the notifications configuration.</p>",
"NotificationsConfiguration$SnsTopicArn": "<p>The ARN of the SNS topic.</p>",
"NotificationsConfiguration$SqsQueueArn": "<p>The ARN of the SQS queue.</p>"
}
},
"Attendee": {
"base": "<p>An Amazon Chime SDK meeting attendee. Includes a unique <code>AttendeeId</code> and <code>JoinToken</code>. The <code>JoinToken</code> allows a client to authenticate and join as the specified attendee. The <code>JoinToken</code> expires when the meeting ends, or when <a>DeleteAttendee</a> is called. After that, the attendee is unable to join the meeting. </p> <p>We recommend securely transferring each <code>JoinToken</code> from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.</p>",
"refs": {
"AttendeeList$member": null,
"CreateAttendeeResponse$Attendee": "<p>The attendee information, including attendee ID and join token.</p>",
"GetAttendeeResponse$Attendee": "<p>The Amazon Chime SDK attendee information.</p>",
"UpdateAttendeeCapabilitiesResponse$Attendee": "<p>The updated attendee data.</p>"
}
},
"AttendeeCapabilities": {
"base": "<p>The media capabilities of an attendee: audio, video, or content. </p> <note> <p>You use the capabilities with a set of values that control what the capabilities can do, such as <code>SendReceive</code> data. For more information about those values, see .</p> </note> <p>When using capabilities, be aware of these corner cases:</p> <ul> <li> <p>You can't set <code>content</code> capabilities to <code>SendReceive</code> or <code>Receive</code> unless you also set <code>video</code> capabilities to <code>SendReceive</code> or <code>Receive</code>. If you don't set the <code>video</code> capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your <code>video</code> capability to receive and you set your <code>content</code> capability to not receive.</p> </li> <li> <p>When you change an <code>audio</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.</p> </li> <li> <p>When you change a <code>video</code> or <code>content</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.</p> </li> </ul>",
"refs": {
"Attendee$Capabilities": "<p>The capabilities assigned to an attendee: audio, video, or content.</p> <note> <p>You use the capabilities with a set of values that control what the capabilities can do, such as <code>SendReceive</code> data. For more information about those values, see .</p> </note> <p>When using capabilities, be aware of these corner cases:</p> <ul> <li> <p>You can't set <code>content</code> capabilities to <code>SendReceive</code> or <code>Receive</code> unless you also set <code>video</code> capabilities to <code>SendReceive</code> or <code>Receive</code>. If you don't set the <code>video</code> capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your <code>video</code> capability to receive and you set your <code>content</code> capability to not receive.</p> </li> <li> <p>When you change an <code>audio</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.</p> </li> <li> <p>When you change a <code>video</code> or <code>content</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.</p> </li> </ul>",
"BatchUpdateAttendeeCapabilitiesExceptRequest$Capabilities": "<p>The capabilities (<code>audio</code>, <code>video</code>, or <code>content</code>) that you want to update.</p>",
"CreateAttendeeRequest$Capabilities": "<p>The capabilities (<code>audio</code>, <code>video</code>, or <code>content</code>) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.</p> <note> <p>You use the capabilities with a set of values that control what the capabilities can do, such as <code>SendReceive</code> data. For more information about those values, see .</p> </note> <p>When using capabilities, be aware of these corner cases:</p> <ul> <li> <p>You can't set <code>content</code> capabilities to <code>SendReceive</code> or <code>Receive</code> unless you also set <code>video</code> capabilities to <code>SendReceive</code> or <code>Receive</code>. If you don't set the <code>video</code> capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your <code>video</code> capability to receive and you set your <code>content</code> capability to not receive.</p> </li> <li> <p>When you change an <code>audio</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.</p> </li> <li> <p>When you change a <code>video</code> or <code>content</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.</p> </li> </ul>",
"CreateAttendeeRequestItem$Capabilities": "<p>A list of one or more capabilities.</p>",
"UpdateAttendeeCapabilitiesRequest$Capabilities": "<p>The capabilties that you want to update.</p>"
}
},
"AttendeeIdItem": {
"base": "<p>A structure that contains one or more attendee IDs.</p>",
"refs": {
"AttendeeIdsList$member": null
}
},
"AttendeeIdsList": {
"base": null,
"refs": {
"BatchUpdateAttendeeCapabilitiesExceptRequest$ExcludedAttendeeIds": "<p>The <code>AttendeeIDs</code> that you want to exclude from one or more capabilities.</p>"
}
},
"AttendeeList": {
"base": null,
"refs": {
"BatchCreateAttendeeResponse$Attendees": "<p>The attendee information, including attendees' IDs and join tokens.</p>",
"CreateMeetingWithAttendeesResponse$Attendees": "<p>The attendee information, including attendees' IDs and join tokens.</p>",
"ListAttendeesResponse$Attendees": "<p>The Amazon Chime SDK attendee information.</p>"
}
},
"AudioFeatures": {
"base": "<p>An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus. </p>",
"refs": {
"MeetingFeaturesConfiguration$Audio": "<p>The configuration settings for the audio features available to a meeting. </p>"
}
},
"BadRequestException": {
"base": "<p>The input parameters don't match the service's restrictions.</p>",
"refs": {
}
},
"BatchCreateAttendeeErrorList": {
"base": null,
"refs": {
"BatchCreateAttendeeResponse$Errors": "<p>If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.</p>",
"CreateMeetingWithAttendeesResponse$Errors": "<p>If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.</p>"
}
},
"BatchCreateAttendeeRequest": {
"base": null,
"refs": {
}
},
"BatchCreateAttendeeResponse": {
"base": null,
"refs": {
}
},
"BatchUpdateAttendeeCapabilitiesExceptRequest": {
"base": null,
"refs": {
}
},
"Boolean": {
"base": null,
"refs": {
"EngineTranscribeSettings$EnablePartialResultsStabilization": "<p>Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.</p>",
"EngineTranscribeSettings$IdentifyLanguage": "<p>Automatically identifies the language spoken in media files.</p>"
}
},
"ClientRequestToken": {
"base": null,
"refs": {
"CreateMeetingRequest$ClientRequestToken": "<p>The unique identifier for the client request. Use a different token for different meetings.</p>",
"CreateMeetingWithAttendeesRequest$ClientRequestToken": "<p>The unique identifier for the client request. Use a different token for different meetings.</p>"
}
},
"ConflictException": {
"base": "<p>Multiple instances of the same request have been made simultaneously.</p>",
"refs": {
}
},
"CreateAttendeeError": {
"base": "<p>The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.</p>",
"refs": {
"BatchCreateAttendeeErrorList$member": null
}
},
"CreateAttendeeRequest": {
"base": null,
"refs": {
}
},
"CreateAttendeeRequestItem": {
"base": "<p>The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.</p>",
"refs": {
"CreateAttendeeRequestItemList$member": null,
"CreateMeetingWithAttendeesRequestItemList$member": null
}
},
"CreateAttendeeRequestItemList": {
"base": null,
"refs": {
"BatchCreateAttendeeRequest$Attendees": "<p>The attendee information, including attendees' IDs and join tokens.</p>"
}
},
"CreateAttendeeResponse": {
"base": null,
"refs": {
}
},
"CreateMeetingRequest": {
"base": null,
"refs": {
}
},
"CreateMeetingResponse": {
"base": null,
"refs": {
}
},
"CreateMeetingWithAttendeesRequest": {
"base": null,
"refs": {
}
},
"CreateMeetingWithAttendeesRequestItemList": {
"base": null,
"refs": {
"CreateMeetingWithAttendeesRequest$Attendees": "<p>The attendee information, including attendees' IDs and join tokens.</p>"
}
},
"CreateMeetingWithAttendeesResponse": {
"base": null,
"refs": {
}
},
"DeleteAttendeeRequest": {
"base": null,
"refs": {
}
},
"DeleteMeetingRequest": {
"base": null,
"refs": {
}
},
"EngineTranscribeMedicalSettings": {
"base": "<p>Settings specific to the Amazon Transcribe Medical engine.</p>",
"refs": {
"TranscriptionConfiguration$EngineTranscribeMedicalSettings": "<p>The transcription configuration settings passed to Amazon Transcribe Medical.</p>"
}
},
"EngineTranscribeSettings": {
"base": "<p>Settings specific to the Amazon Transcribe engine.</p>",
"refs": {
"TranscriptionConfiguration$EngineTranscribeSettings": "<p>The transcription configuration settings passed to Amazon Transcribe.</p>"
}
},
"ExternalMeetingId": {
"base": null,
"refs": {
"CreateMeetingRequest$ExternalMeetingId": "<p>The external meeting ID.</p>",
"CreateMeetingWithAttendeesRequest$ExternalMeetingId": "<p>The external meeting ID.</p>",
"Meeting$ExternalMeetingId": "<p>The external meeting ID.</p>"
}
},
"ExternalUserId": {
"base": null,
"refs": {
"Attendee$ExternalUserId": "<p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>",
"CreateAttendeeError$ExternalUserId": "<p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>",
"CreateAttendeeRequest$ExternalUserId": "<p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>",
"CreateAttendeeRequestItem$ExternalUserId": "<p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>",
"CreateMeetingRequest$MeetingHostId": "<p>Reserved.</p>",
"CreateMeetingWithAttendeesRequest$MeetingHostId": "<p>Reserved.</p>",
"Meeting$MeetingHostId": "<p>Reserved.</p>"
}
},
"ForbiddenException": {
"base": "<p>The client is permanently forbidden from making the request.</p>",
"refs": {
}
},
"GetAttendeeRequest": {
"base": null,
"refs": {
}
},
"GetAttendeeResponse": {
"base": null,
"refs": {
}
},
"GetMeetingRequest": {
"base": null,
"refs": {
}
},
"GetMeetingResponse": {
"base": null,
"refs": {
}
},
"GuidString": {
"base": null,
"refs": {
"Attendee$AttendeeId": "<p>The Amazon Chime SDK attendee ID.</p>",
"AttendeeIdItem$AttendeeId": "<p>A list of one or more attendee IDs.</p>",
"BatchCreateAttendeeRequest$MeetingId": "<p>The Amazon Chime SDK ID of the meeting to which you're adding attendees.</p>",
"BatchUpdateAttendeeCapabilitiesExceptRequest$MeetingId": "<p>The ID of the meeting associated with the update request.</p>",
"CreateAttendeeRequest$MeetingId": "<p>The unique ID of the meeting.</p>",
"DeleteAttendeeRequest$MeetingId": "<p>The Amazon Chime SDK meeting ID.</p>",
"DeleteAttendeeRequest$AttendeeId": "<p>The Amazon Chime SDK attendee ID.</p>",
"DeleteMeetingRequest$MeetingId": "<p>The Amazon Chime SDK meeting ID.</p>",
"GetAttendeeRequest$MeetingId": "<p>The Amazon Chime SDK meeting ID.</p>",
"GetAttendeeRequest$AttendeeId": "<p>The Amazon Chime SDK attendee ID.</p>",
"GetMeetingRequest$MeetingId": "<p>The Amazon Chime SDK meeting ID.</p>",
"ListAttendeesRequest$MeetingId": "<p>The Amazon Chime SDK meeting ID.</p>",
"Meeting$MeetingId": "<p>The Amazon Chime SDK meeting ID.</p>",
"StartMeetingTranscriptionRequest$MeetingId": "<p>The unique ID of the meeting being transcribed.</p>",
"StopMeetingTranscriptionRequest$MeetingId": "<p>The unique ID of the meeting for which you stop transcription.</p>",
"UpdateAttendeeCapabilitiesRequest$MeetingId": "<p>The ID of the meeting associated with the update request.</p>",
"UpdateAttendeeCapabilitiesRequest$AttendeeId": "<p>The ID of the attendee associated with the update request.</p>"
}
},
"JoinTokenString": {
"base": null,
"refs": {
"Attendee$JoinToken": "<p>The join token used by the Amazon Chime SDK attendee.</p>"
}
},
"LimitExceededException": {
"base": "<p>The request exceeds the resource limit.</p>",
"refs": {
}
},
"ListAttendeesRequest": {
"base": null,
"refs": {
}
},
"ListAttendeesResponse": {
"base": null,
"refs": {
}
},
"MediaCapabilities": {
"base": null,
"refs": {
"AttendeeCapabilities$Audio": "<p>The audio capability assigned to an attendee.</p>",
"AttendeeCapabilities$Video": "<p>The video capability assigned to an attendee.</p>",
"AttendeeCapabilities$Content": "<p>The content capability assigned to an attendee.</p>"
}
},
"MediaPlacement": {
"base": "<p>A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.</p>",
"refs": {
"Meeting$MediaPlacement": "<p>The media placement for the meeting.</p>"
}
},
"MediaRegion": {
"base": null,
"refs": {
"CreateMeetingRequest$MediaRegion": "<p>The Region in which to create the meeting.</p> <p> Available values: <code>af-south-1</code>, <code>ap-northeast-1</code>, <code>ap-northeast-2</code>, <code>ap-south-1</code>, <code>ap-southeast-1</code>, <code>ap-southeast-2</code>, <code>ca-central-1</code>, <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-south-1</code>, <code>eu-west-1</code>, <code>eu-west-2</code>, <code>eu-west-3</code>, <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>, <code>us-west-1</code>, <code>us-west-2</code>. </p> <p>Available values in AWS GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>",
"CreateMeetingWithAttendeesRequest$MediaRegion": "<p>The Region in which to create the meeting.</p> <p> Available values: <code>af-south-1</code>, <code>ap-northeast-1</code>, <code>ap-northeast-2</code>, <code>ap-south-1</code>, <code>ap-southeast-1</code>, <code>ap-southeast-2</code>, <code>ca-central-1</code>, <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-south-1</code>, <code>eu-west-1</code>, <code>eu-west-2</code>, <code>eu-west-3</code>, <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>, <code>us-west-1</code>, <code>us-west-2</code>. </p> <p>Available values in AWS GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>",
"Meeting$MediaRegion": "<p>The Region in which you create the meeting. Available values: <code>af-south-1</code>, <code>ap-northeast-1</code>, <code>ap-northeast-2</code>, <code>ap-south-1</code>, <code>ap-southeast-1</code>, <code>ap-southeast-2</code>, <code>ca-central-1</code>, <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-south-1</code>, <code>eu-west-1</code>, <code>eu-west-2</code>, <code>eu-west-3</code>, <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>, <code>us-west-1</code>, <code>us-west-2</code>.</p> <p>Available values in AWS GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>"
}
},
"Meeting": {
"base": "<p>A meeting created using the Amazon Chime SDK.</p>",
"refs": {
"CreateMeetingResponse$Meeting": "<p>The meeting information, including the meeting ID and <code>MediaPlacement</code>.</p>",
"CreateMeetingWithAttendeesResponse$Meeting": "<p>The meeting information, including the meeting ID and <code>MediaPlacement</code>.</p>",
"GetMeetingResponse$Meeting": "<p>The Amazon Chime SDK meeting information.</p>"
}
},
"MeetingFeatureStatus": {
"base": null,
"refs": {
"AudioFeatures$EchoReduction": "<p>Makes echo reduction available to clients who connect to the meeting.</p>"
}
},
"MeetingFeaturesConfiguration": {
"base": "<p>The configuration settings of the features available to a meeting.></p>",
"refs": {
"CreateMeetingRequest$MeetingFeatures": "<p>Lists the audio and video features enabled for a meeting, such as echo reduction.</p>",
"CreateMeetingWithAttendeesRequest$MeetingFeatures": "<p>Lists the audio and video features enabled for a meeting, such as echo reduction.</p>",
"Meeting$MeetingFeatures": "<p>The features available to a meeting, such as Amazon Voice Focus.</p>"
}
},
"NotFoundException": {
"base": "<p>One or more of the resources in the request does not exist in the system.</p>",
"refs": {
}
},
"NotificationsConfiguration": {
"base": "<p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>",
"refs": {
"CreateMeetingRequest$NotificationsConfiguration": "<p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>",
"CreateMeetingWithAttendeesRequest$NotificationsConfiguration": "<p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>"
}
},
"PrimaryMeetingId": {
"base": null,
"refs": {
"CreateMeetingRequest$PrimaryMeetingId": "<p>When specified, replicates the media from the primary meeting to the new meeting.</p>",
"CreateMeetingWithAttendeesRequest$PrimaryMeetingId": "<p>When specified, replicates the media from the primary meeting to the new meeting.</p>",
"Meeting$PrimaryMeetingId": "<p>When specified, replicates the media from the primary meeting to this meeting.</p>"
}
},
"ResultMax": {
"base": null,
"refs": {
"ListAttendeesRequest$MaxResults": "<p>The maximum number of results to return in a single call.</p>"
}
},
"RetryAfterSeconds": {
"base": null,
"refs": {
"ServiceUnavailableException$RetryAfterSeconds": "<p>The number of seconds the caller should wait before retrying.</p>"
}
},
"ServiceFailureException": {
"base": "<p>The service encountered an unexpected error.</p>",
"refs": {
}
},
"ServiceUnavailableException": {
"base": "<p>The service is currently unavailable.</p>",
"refs": {
}
},
"StartMeetingTranscriptionRequest": {
"base": null,
"refs": {
}
},
"StopMeetingTranscriptionRequest": {
"base": null,
"refs": {
}
},
"String": {
"base": null,
"refs": {
"BadRequestException$Code": null,
"BadRequestException$Message": null,
"BadRequestException$RequestId": "<p>The request id associated with the call responsible for the exception.</p>",
"ConflictException$Code": null,
"ConflictException$Message": null,
"ConflictException$RequestId": null,
"CreateAttendeeError$ErrorCode": "<p>The error code.</p>",
"CreateAttendeeError$ErrorMessage": "<p>The error message.</p>",
"EngineTranscribeMedicalSettings$VocabularyName": "<p>The name of the vocabulary passed to Amazon Transcribe Medical.</p>",
"EngineTranscribeSettings$VocabularyFilterName": "<p>The name of the vocabulary filter passed to Amazon Transcribe.</p>",
"EngineTranscribeSettings$VocabularyName": "<p>The name of the vocabulary passed to Amazon Transcribe.</p>",
"ForbiddenException$Code": null,
"ForbiddenException$Message": null,
"ForbiddenException$RequestId": "<p>The request id associated with the call responsible for the exception.</p>",
"LimitExceededException$Code": null,
"LimitExceededException$Message": null,
"LimitExceededException$RequestId": "<p>The request id associated with the call responsible for the exception.</p>",
"ListAttendeesRequest$NextToken": "<p>The token to use to retrieve the next page of results.</p>",
"ListAttendeesResponse$NextToken": "<p>The token to use to retrieve the next page of results.</p>",
"MediaPlacement$AudioHostUrl": "<p>The audio host URL.</p>",
"MediaPlacement$AudioFallbackUrl": "<p>The audio fallback URL.</p>",
"MediaPlacement$SignalingUrl": "<p>The signaling URL.</p>",
"MediaPlacement$TurnControlUrl": "<p>The turn control URL.</p>",
"MediaPlacement$ScreenDataUrl": "<p>The screen data URL.</p>",
"MediaPlacement$ScreenViewingUrl": "<p>The screen viewing URL.</p>",
"MediaPlacement$ScreenSharingUrl": "<p>The screen sharing URL.</p>",
"MediaPlacement$EventIngestionUrl": "<p>The event ingestion URL.</p>",
"NotFoundException$Code": null,
"NotFoundException$Message": null,
"NotFoundException$RequestId": "<p>The request ID associated with the call responsible for the exception.</p>",
"ServiceFailureException$Code": null,
"ServiceFailureException$Message": null,
"ServiceFailureException$RequestId": null,
"ServiceUnavailableException$Code": null,
"ServiceUnavailableException$Message": null,
"ServiceUnavailableException$RequestId": "<p>The request id associated with the call responsible for the exception.</p>",
"ThrottlingException$Code": null,
"ThrottlingException$Message": null,
"ThrottlingException$RequestId": null,
"UnauthorizedException$Code": null,
"UnauthorizedException$Message": null,
"UnauthorizedException$RequestId": "<p>The request id associated with the call responsible for the exception.</p>",
"UnprocessableEntityException$Code": null,
"UnprocessableEntityException$Message": null,
"UnprocessableEntityException$RequestId": "<p>The request id associated with the call responsible for the exception.</p>"
}
},
"TenantId": {
"base": null,
"refs": {
"TenantIdList$member": null
}
},
"TenantIdList": {
"base": null,
"refs": {
"CreateMeetingRequest$TenantIds": "<p>A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.</p>",
"CreateMeetingWithAttendeesRequest$TenantIds": "<p>A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.</p>",
"Meeting$TenantIds": "<p>Array of strings.</p>"
}
},
"ThrottlingException": {
"base": "<p>The number of customer requests exceeds the request rate limit.</p>",
"refs": {
}
},
"TranscribeContentIdentificationType": {
"base": null,
"refs": {
"EngineTranscribeSettings$ContentIdentificationType": "<p>Set this field to <code>PII</code> to identify personally identifiable information in the transcription output.</p>"
}
},
"TranscribeContentRedactionType": {
"base": null,
"refs": {
"EngineTranscribeSettings$ContentRedactionType": "<p>Set this field to <code>PII</code> to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.</p> <p>You can’t set <code>ContentRedactionType</code> and <code>ContentIdentificationType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>"
}
},
"TranscribeLanguageCode": {
"base": null,
"refs": {
"EngineTranscribeSettings$LanguageCode": "<p>The language code specified for the Amazon Transcribe engine.</p>",
"EngineTranscribeSettings$PreferredLanguage": "<p>Language code for the preferred language.</p>"
}
},
"TranscribeLanguageModelName": {
"base": null,
"refs": {
"EngineTranscribeSettings$LanguageModelName": "<p>The name of the language model used during transcription.</p>"
}
},
"TranscribeLanguageOptions": {
"base": null,
"refs": {
"EngineTranscribeSettings$LanguageOptions": "<p>Language codes for the languages that you want to identify. You must provide at least 2 codes.</p>"
}
},
"TranscribeMedicalContentIdentificationType": {
"base": null,
"refs": {
"EngineTranscribeMedicalSettings$ContentIdentificationType": "<p>Set this field to <code>PHI</code> to identify personal health information in the transcription output.</p>"
}
},
"TranscribeMedicalLanguageCode": {
"base": null,
"refs": {
"EngineTranscribeMedicalSettings$LanguageCode": "<p>The language code specified for the Amazon Transcribe Medical engine.</p>"
}
},
"TranscribeMedicalRegion": {
"base": null,
"refs": {
"EngineTranscribeMedicalSettings$Region": "<p>The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region. </p>"
}
},
"TranscribeMedicalSpecialty": {
"base": null,
"refs": {
"EngineTranscribeMedicalSettings$Specialty": "<p>The specialty specified for the Amazon Transcribe Medical engine.</p>"
}
},
"TranscribeMedicalType": {
"base": null,
"refs": {
"EngineTranscribeMedicalSettings$Type": "<p>The type of transcription.</p>"
}
},
"TranscribePartialResultsStability": {
"base": null,
"refs": {
"EngineTranscribeSettings$PartialResultsStability": "<p>The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.</p>"
}
},
"TranscribePiiEntityTypes": {
"base": null,
"refs": {
"EngineTranscribeSettings$PiiEntityTypes": "<p>Lists the PII entity types you want to identify or redact. To specify entity types, you must enable <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p> <p> <code>PIIEntityTypes</code> must be comma-separated. The available values are: <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING, CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>, <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>, <code>SSN</code>, and <code>ALL</code>.</p> <p> <code>PiiEntityTypes</code> is an optional parameter with a default value of <code>ALL</code>.</p>"
}
},
"TranscribeRegion": {
"base": null,
"refs": {
"EngineTranscribeSettings$Region": "<p>The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.</p>"
}
},
"TranscribeVocabularyFilterMethod": {
"base": null,
"refs": {
"EngineTranscribeSettings$VocabularyFilterMethod": "<p>The filtering method passed to Amazon Transcribe.</p>"
}
},
"TranscriptionConfiguration": {
"base": "<p>The configuration for the current transcription operation. Must contain <code>EngineTranscribeSettings</code> or <code>EngineTranscribeMedicalSettings</code>.</p>",
"refs": {
"StartMeetingTranscriptionRequest$TranscriptionConfiguration": "<p>The configuration for the current transcription operation. Must contain <code>EngineTranscribeSettings</code> or <code>EngineTranscribeMedicalSettings</code>.</p>"
}
},
"UnauthorizedException": {
"base": "<p>The user isn't authorized to request a resource.</p>",
"refs": {
}
},
"UnprocessableEntityException": {
"base": "<p>The request was well-formed but was unable to be followed due to semantic errors.</p>",
"refs": {
}
},
"UpdateAttendeeCapabilitiesRequest": {
"base": null,
"refs": {
}
},
"UpdateAttendeeCapabilitiesResponse": {
"base": null,
"refs": {
}
}
}
}