@aws-sdk/client-chime-sdk-meetings 3.533.0 → 3.540.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.
- package/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/ChimeSDKMeetings.d.ts +1 -1
- package/dist-types/ChimeSDKMeetingsClient.d.ts +1 -1
- package/dist-types/commands/BatchCreateAttendeeCommand.d.ts +2 -1
- package/dist-types/commands/BatchUpdateAttendeeCapabilitiesExceptCommand.d.ts +2 -1
- package/dist-types/commands/CreateAttendeeCommand.d.ts +2 -1
- package/dist-types/commands/CreateMeetingCommand.d.ts +2 -1
- package/dist-types/commands/CreateMeetingWithAttendeesCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAttendeeCommand.d.ts +2 -1
- package/dist-types/commands/DeleteMeetingCommand.d.ts +2 -1
- package/dist-types/commands/GetAttendeeCommand.d.ts +2 -1
- package/dist-types/commands/GetMeetingCommand.d.ts +2 -1
- package/dist-types/commands/ListAttendeesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/StartMeetingTranscriptionCommand.d.ts +2 -1
- package/dist-types/commands/StopMeetingTranscriptionCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAttendeeCapabilitiesCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +171 -171
- package/dist-types/ts3.4/commands/BatchCreateAttendeeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchUpdateAttendeeCapabilitiesExceptCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateAttendeeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateMeetingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateMeetingWithAttendeesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAttendeeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteMeetingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAttendeeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMeetingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAttendeesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartMeetingTranscriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopMeetingTranscriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateAttendeeCapabilitiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -15,7 +15,6 @@ export declare const MediaCapabilities: {
|
|
|
15
15
|
*/
|
|
16
16
|
export type MediaCapabilities = (typeof MediaCapabilities)[keyof typeof MediaCapabilities];
|
|
17
17
|
/**
|
|
18
|
-
* @public
|
|
19
18
|
* <p>The media capabilities of an attendee: audio, video, or content.</p>
|
|
20
19
|
* <note>
|
|
21
20
|
* <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, refer to
|
|
@@ -45,26 +44,26 @@ export type MediaCapabilities = (typeof MediaCapabilities)[keyof typeof MediaCap
|
|
|
45
44
|
* and the attendee turns on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.</p>
|
|
46
45
|
* </li>
|
|
47
46
|
* </ul>
|
|
47
|
+
* @public
|
|
48
48
|
*/
|
|
49
49
|
export interface AttendeeCapabilities {
|
|
50
50
|
/**
|
|
51
|
-
* @public
|
|
52
51
|
* <p>The audio capability assigned to an attendee.</p>
|
|
52
|
+
* @public
|
|
53
53
|
*/
|
|
54
54
|
Audio: MediaCapabilities | undefined;
|
|
55
55
|
/**
|
|
56
|
-
* @public
|
|
57
56
|
* <p>The video capability assigned to an attendee.</p>
|
|
57
|
+
* @public
|
|
58
58
|
*/
|
|
59
59
|
Video: MediaCapabilities | undefined;
|
|
60
60
|
/**
|
|
61
|
-
* @public
|
|
62
61
|
* <p>The content capability assigned to an attendee.</p>
|
|
62
|
+
* @public
|
|
63
63
|
*/
|
|
64
64
|
Content: MediaCapabilities | undefined;
|
|
65
65
|
}
|
|
66
66
|
/**
|
|
67
|
-
* @public
|
|
68
67
|
* <p>An Amazon Chime SDK meeting attendee. Includes a unique
|
|
69
68
|
* <code>AttendeeId</code> and <code>JoinToken</code>. The
|
|
70
69
|
* <code>JoinToken</code>
|
|
@@ -77,29 +76,29 @@ export interface AttendeeCapabilities {
|
|
|
77
76
|
* <p>We recommend securely transferring each <code>JoinToken</code> from your server application
|
|
78
77
|
* to the client so that no other client has access to the token except for the one
|
|
79
78
|
* authorized to represent the attendee.</p>
|
|
79
|
+
* @public
|
|
80
80
|
*/
|
|
81
81
|
export interface Attendee {
|
|
82
82
|
/**
|
|
83
|
-
* @public
|
|
84
83
|
* <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
|
|
85
84
|
* <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
|
|
86
85
|
* </p>
|
|
87
86
|
* <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
|
|
88
87
|
* Case insensitive.</p>
|
|
88
|
+
* @public
|
|
89
89
|
*/
|
|
90
90
|
ExternalUserId?: string;
|
|
91
91
|
/**
|
|
92
|
-
* @public
|
|
93
92
|
* <p>The Amazon Chime SDK attendee ID.</p>
|
|
93
|
+
* @public
|
|
94
94
|
*/
|
|
95
95
|
AttendeeId?: string;
|
|
96
96
|
/**
|
|
97
|
-
* @public
|
|
98
97
|
* <p>The join token used by the Amazon Chime SDK attendee.</p>
|
|
98
|
+
* @public
|
|
99
99
|
*/
|
|
100
100
|
JoinToken?: string;
|
|
101
101
|
/**
|
|
102
|
-
* @public
|
|
103
102
|
* <p>The capabilities assigned to an attendee: audio, video, or content.</p>
|
|
104
103
|
* <note>
|
|
105
104
|
* <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
|
|
@@ -129,32 +128,33 @@ export interface Attendee {
|
|
|
129
128
|
* and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.</p>
|
|
130
129
|
* </li>
|
|
131
130
|
* </ul>
|
|
131
|
+
* @public
|
|
132
132
|
*/
|
|
133
133
|
Capabilities?: AttendeeCapabilities;
|
|
134
134
|
}
|
|
135
135
|
/**
|
|
136
|
-
* @public
|
|
137
136
|
* <p>Lists the maximum number of attendees allowed into the meeting.</p>
|
|
138
137
|
* <note>
|
|
139
138
|
* <p>If you specify <code>FHD</code> for <code>MeetingFeatures:Video:MaxResolution</code>, or if you specify
|
|
140
139
|
* <code>UHD</code> for <code>MeetingFeatures:Content:MaxResolution</code>, the maximum number of attendees changes from the default of <code>250</code> to <code>25</code>.</p>
|
|
141
140
|
* </note>
|
|
141
|
+
* @public
|
|
142
142
|
*/
|
|
143
143
|
export interface AttendeeFeatures {
|
|
144
144
|
/**
|
|
145
|
-
* @public
|
|
146
145
|
* <p>The maximum number of attendees allowed into the meeting.</p>
|
|
146
|
+
* @public
|
|
147
147
|
*/
|
|
148
148
|
MaxCount?: number;
|
|
149
149
|
}
|
|
150
150
|
/**
|
|
151
|
-
* @public
|
|
152
151
|
* <p>A structure that contains one or more attendee IDs.</p>
|
|
152
|
+
* @public
|
|
153
153
|
*/
|
|
154
154
|
export interface AttendeeIdItem {
|
|
155
155
|
/**
|
|
156
|
-
* @public
|
|
157
156
|
* <p>A list of one or more attendee IDs.</p>
|
|
157
|
+
* @public
|
|
158
158
|
*/
|
|
159
159
|
AttendeeId: string | undefined;
|
|
160
160
|
}
|
|
@@ -171,19 +171,19 @@ export declare const MeetingFeatureStatus: {
|
|
|
171
171
|
*/
|
|
172
172
|
export type MeetingFeatureStatus = (typeof MeetingFeatureStatus)[keyof typeof MeetingFeatureStatus];
|
|
173
173
|
/**
|
|
174
|
-
* @public
|
|
175
174
|
* <p>An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus. </p>
|
|
175
|
+
* @public
|
|
176
176
|
*/
|
|
177
177
|
export interface AudioFeatures {
|
|
178
178
|
/**
|
|
179
|
-
* @public
|
|
180
179
|
* <p>Makes echo reduction available to clients who connect to the meeting.</p>
|
|
180
|
+
* @public
|
|
181
181
|
*/
|
|
182
182
|
EchoReduction?: MeetingFeatureStatus;
|
|
183
183
|
}
|
|
184
184
|
/**
|
|
185
|
-
* @public
|
|
186
185
|
* <p>The input parameters don't match the service's restrictions.</p>
|
|
186
|
+
* @public
|
|
187
187
|
*/
|
|
188
188
|
export declare class BadRequestException extends __BaseException {
|
|
189
189
|
readonly name: "BadRequestException";
|
|
@@ -191,8 +191,8 @@ export declare class BadRequestException extends __BaseException {
|
|
|
191
191
|
Code?: string;
|
|
192
192
|
Message?: string;
|
|
193
193
|
/**
|
|
194
|
-
* @public
|
|
195
194
|
* <p>The request id associated with the call responsible for the exception.</p>
|
|
195
|
+
* @public
|
|
196
196
|
*/
|
|
197
197
|
RequestId?: string;
|
|
198
198
|
/**
|
|
@@ -201,22 +201,22 @@ export declare class BadRequestException extends __BaseException {
|
|
|
201
201
|
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
202
202
|
}
|
|
203
203
|
/**
|
|
204
|
-
* @public
|
|
205
204
|
* <p>The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.</p>
|
|
205
|
+
* @public
|
|
206
206
|
*/
|
|
207
207
|
export interface CreateAttendeeRequestItem {
|
|
208
208
|
/**
|
|
209
|
-
* @public
|
|
210
209
|
* <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
|
|
211
210
|
* <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
|
|
212
211
|
* </p>
|
|
213
212
|
* <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
|
|
214
213
|
* Case insensitive.</p>
|
|
214
|
+
* @public
|
|
215
215
|
*/
|
|
216
216
|
ExternalUserId: string | undefined;
|
|
217
217
|
/**
|
|
218
|
-
* @public
|
|
219
218
|
* <p>A list of one or more capabilities.</p>
|
|
219
|
+
* @public
|
|
220
220
|
*/
|
|
221
221
|
Capabilities?: AttendeeCapabilities;
|
|
222
222
|
}
|
|
@@ -225,38 +225,38 @@ export interface CreateAttendeeRequestItem {
|
|
|
225
225
|
*/
|
|
226
226
|
export interface BatchCreateAttendeeRequest {
|
|
227
227
|
/**
|
|
228
|
-
* @public
|
|
229
228
|
* <p>The Amazon Chime SDK ID of the meeting to which you're adding attendees.</p>
|
|
229
|
+
* @public
|
|
230
230
|
*/
|
|
231
231
|
MeetingId: string | undefined;
|
|
232
232
|
/**
|
|
233
|
-
* @public
|
|
234
233
|
* <p>The attendee information, including attendees' IDs and join tokens.</p>
|
|
234
|
+
* @public
|
|
235
235
|
*/
|
|
236
236
|
Attendees: CreateAttendeeRequestItem[] | undefined;
|
|
237
237
|
}
|
|
238
238
|
/**
|
|
239
|
-
* @public
|
|
240
239
|
* <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>
|
|
240
|
+
* @public
|
|
241
241
|
*/
|
|
242
242
|
export interface CreateAttendeeError {
|
|
243
243
|
/**
|
|
244
|
-
* @public
|
|
245
244
|
* <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
|
|
246
245
|
* <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
|
|
247
246
|
* </p>
|
|
248
247
|
* <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
|
|
249
248
|
* Case insensitive.</p>
|
|
249
|
+
* @public
|
|
250
250
|
*/
|
|
251
251
|
ExternalUserId?: string;
|
|
252
252
|
/**
|
|
253
|
-
* @public
|
|
254
253
|
* <p>The error code.</p>
|
|
254
|
+
* @public
|
|
255
255
|
*/
|
|
256
256
|
ErrorCode?: string;
|
|
257
257
|
/**
|
|
258
|
-
* @public
|
|
259
258
|
* <p>The error message.</p>
|
|
259
|
+
* @public
|
|
260
260
|
*/
|
|
261
261
|
ErrorMessage?: string;
|
|
262
262
|
}
|
|
@@ -265,19 +265,19 @@ export interface CreateAttendeeError {
|
|
|
265
265
|
*/
|
|
266
266
|
export interface BatchCreateAttendeeResponse {
|
|
267
267
|
/**
|
|
268
|
-
* @public
|
|
269
268
|
* <p>The attendee information, including attendees' IDs and join tokens.</p>
|
|
269
|
+
* @public
|
|
270
270
|
*/
|
|
271
271
|
Attendees?: Attendee[];
|
|
272
272
|
/**
|
|
273
|
-
* @public
|
|
274
273
|
* <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>
|
|
274
|
+
* @public
|
|
275
275
|
*/
|
|
276
276
|
Errors?: CreateAttendeeError[];
|
|
277
277
|
}
|
|
278
278
|
/**
|
|
279
|
-
* @public
|
|
280
279
|
* <p>The client is permanently forbidden from making the request.</p>
|
|
280
|
+
* @public
|
|
281
281
|
*/
|
|
282
282
|
export declare class ForbiddenException extends __BaseException {
|
|
283
283
|
readonly name: "ForbiddenException";
|
|
@@ -285,8 +285,8 @@ export declare class ForbiddenException extends __BaseException {
|
|
|
285
285
|
Code?: string;
|
|
286
286
|
Message?: string;
|
|
287
287
|
/**
|
|
288
|
-
* @public
|
|
289
288
|
* <p>The request id associated with the call responsible for the exception.</p>
|
|
289
|
+
* @public
|
|
290
290
|
*/
|
|
291
291
|
RequestId?: string;
|
|
292
292
|
/**
|
|
@@ -295,8 +295,8 @@ export declare class ForbiddenException extends __BaseException {
|
|
|
295
295
|
constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
|
|
296
296
|
}
|
|
297
297
|
/**
|
|
298
|
-
* @public
|
|
299
298
|
* <p>The request exceeds the resource limit.</p>
|
|
299
|
+
* @public
|
|
300
300
|
*/
|
|
301
301
|
export declare class LimitExceededException extends __BaseException {
|
|
302
302
|
readonly name: "LimitExceededException";
|
|
@@ -304,8 +304,8 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
304
304
|
Code?: string;
|
|
305
305
|
Message?: string;
|
|
306
306
|
/**
|
|
307
|
-
* @public
|
|
308
307
|
* <p>The request id associated with the call responsible for the exception.</p>
|
|
308
|
+
* @public
|
|
309
309
|
*/
|
|
310
310
|
RequestId?: string;
|
|
311
311
|
/**
|
|
@@ -314,8 +314,8 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
314
314
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
315
315
|
}
|
|
316
316
|
/**
|
|
317
|
-
* @public
|
|
318
317
|
* <p>One or more of the resources in the request does not exist in the system.</p>
|
|
318
|
+
* @public
|
|
319
319
|
*/
|
|
320
320
|
export declare class NotFoundException extends __BaseException {
|
|
321
321
|
readonly name: "NotFoundException";
|
|
@@ -323,8 +323,8 @@ export declare class NotFoundException extends __BaseException {
|
|
|
323
323
|
Code?: string;
|
|
324
324
|
Message?: string;
|
|
325
325
|
/**
|
|
326
|
-
* @public
|
|
327
326
|
* <p>The request ID associated with the call responsible for the exception.</p>
|
|
327
|
+
* @public
|
|
328
328
|
*/
|
|
329
329
|
RequestId?: string;
|
|
330
330
|
/**
|
|
@@ -333,8 +333,8 @@ export declare class NotFoundException extends __BaseException {
|
|
|
333
333
|
constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
|
|
334
334
|
}
|
|
335
335
|
/**
|
|
336
|
-
* @public
|
|
337
336
|
* <p>The service encountered an unexpected error.</p>
|
|
337
|
+
* @public
|
|
338
338
|
*/
|
|
339
339
|
export declare class ServiceFailureException extends __BaseException {
|
|
340
340
|
readonly name: "ServiceFailureException";
|
|
@@ -342,8 +342,8 @@ export declare class ServiceFailureException extends __BaseException {
|
|
|
342
342
|
Code?: string;
|
|
343
343
|
Message?: string;
|
|
344
344
|
/**
|
|
345
|
-
* @public
|
|
346
345
|
* <p>The ID of the failed request.</p>
|
|
346
|
+
* @public
|
|
347
347
|
*/
|
|
348
348
|
RequestId?: string;
|
|
349
349
|
/**
|
|
@@ -352,8 +352,8 @@ export declare class ServiceFailureException extends __BaseException {
|
|
|
352
352
|
constructor(opts: __ExceptionOptionType<ServiceFailureException, __BaseException>);
|
|
353
353
|
}
|
|
354
354
|
/**
|
|
355
|
-
* @public
|
|
356
355
|
* <p>The service is currently unavailable.</p>
|
|
356
|
+
* @public
|
|
357
357
|
*/
|
|
358
358
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
359
359
|
readonly name: "ServiceUnavailableException";
|
|
@@ -361,13 +361,13 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
361
361
|
Code?: string;
|
|
362
362
|
Message?: string;
|
|
363
363
|
/**
|
|
364
|
-
* @public
|
|
365
364
|
* <p>The request id associated with the call responsible for the exception.</p>
|
|
365
|
+
* @public
|
|
366
366
|
*/
|
|
367
367
|
RequestId?: string;
|
|
368
368
|
/**
|
|
369
|
-
* @public
|
|
370
369
|
* <p>The number of seconds the caller should wait before retrying.</p>
|
|
370
|
+
* @public
|
|
371
371
|
*/
|
|
372
372
|
RetryAfterSeconds?: string;
|
|
373
373
|
/**
|
|
@@ -376,8 +376,8 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
376
376
|
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
377
377
|
}
|
|
378
378
|
/**
|
|
379
|
-
* @public
|
|
380
379
|
* <p>The number of customer requests exceeds the request rate limit.</p>
|
|
380
|
+
* @public
|
|
381
381
|
*/
|
|
382
382
|
export declare class ThrottlingException extends __BaseException {
|
|
383
383
|
readonly name: "ThrottlingException";
|
|
@@ -385,8 +385,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
385
385
|
Code?: string;
|
|
386
386
|
Message?: string;
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <p>The ID of the request that exceeded the throttling limit.</p>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
RequestId?: string;
|
|
392
392
|
/**
|
|
@@ -395,8 +395,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
395
395
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
396
396
|
}
|
|
397
397
|
/**
|
|
398
|
-
* @public
|
|
399
398
|
* <p>The user isn't authorized to request a resource.</p>
|
|
399
|
+
* @public
|
|
400
400
|
*/
|
|
401
401
|
export declare class UnauthorizedException extends __BaseException {
|
|
402
402
|
readonly name: "UnauthorizedException";
|
|
@@ -404,8 +404,8 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
404
404
|
Code?: string;
|
|
405
405
|
Message?: string;
|
|
406
406
|
/**
|
|
407
|
-
* @public
|
|
408
407
|
* <p>The request id associated with the call responsible for the exception.</p>
|
|
408
|
+
* @public
|
|
409
409
|
*/
|
|
410
410
|
RequestId?: string;
|
|
411
411
|
/**
|
|
@@ -414,8 +414,8 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
414
414
|
constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
|
|
415
415
|
}
|
|
416
416
|
/**
|
|
417
|
-
* @public
|
|
418
417
|
* <p>The request was well-formed but was unable to be followed due to semantic errors.</p>
|
|
418
|
+
* @public
|
|
419
419
|
*/
|
|
420
420
|
export declare class UnprocessableEntityException extends __BaseException {
|
|
421
421
|
readonly name: "UnprocessableEntityException";
|
|
@@ -423,8 +423,8 @@ export declare class UnprocessableEntityException extends __BaseException {
|
|
|
423
423
|
Code?: string;
|
|
424
424
|
Message?: string;
|
|
425
425
|
/**
|
|
426
|
-
* @public
|
|
427
426
|
* <p>The request id associated with the call responsible for the exception.</p>
|
|
427
|
+
* @public
|
|
428
428
|
*/
|
|
429
429
|
RequestId?: string;
|
|
430
430
|
/**
|
|
@@ -437,24 +437,24 @@ export declare class UnprocessableEntityException extends __BaseException {
|
|
|
437
437
|
*/
|
|
438
438
|
export interface BatchUpdateAttendeeCapabilitiesExceptRequest {
|
|
439
439
|
/**
|
|
440
|
-
* @public
|
|
441
440
|
* <p>The ID of the meeting associated with the update request.</p>
|
|
441
|
+
* @public
|
|
442
442
|
*/
|
|
443
443
|
MeetingId: string | undefined;
|
|
444
444
|
/**
|
|
445
|
-
* @public
|
|
446
445
|
* <p>The <code>AttendeeIDs</code> that you want to exclude from one or more capabilities.</p>
|
|
446
|
+
* @public
|
|
447
447
|
*/
|
|
448
448
|
ExcludedAttendeeIds: AttendeeIdItem[] | undefined;
|
|
449
449
|
/**
|
|
450
|
-
* @public
|
|
451
450
|
* <p>The capabilities (<code>audio</code>, <code>video</code>, or <code>content</code>) that you want to update.</p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
Capabilities: AttendeeCapabilities | undefined;
|
|
454
454
|
}
|
|
455
455
|
/**
|
|
456
|
-
* @public
|
|
457
456
|
* <p>Multiple instances of the same request have been made simultaneously.</p>
|
|
457
|
+
* @public
|
|
458
458
|
*/
|
|
459
459
|
export declare class ConflictException extends __BaseException {
|
|
460
460
|
readonly name: "ConflictException";
|
|
@@ -462,8 +462,8 @@ export declare class ConflictException extends __BaseException {
|
|
|
462
462
|
Code?: string;
|
|
463
463
|
Message?: string;
|
|
464
464
|
/**
|
|
465
|
-
* @public
|
|
466
465
|
* <p>The ID of the request involved in the conflict.</p>
|
|
466
|
+
* @public
|
|
467
467
|
*/
|
|
468
468
|
RequestId?: string;
|
|
469
469
|
/**
|
|
@@ -476,21 +476,20 @@ export declare class ConflictException extends __BaseException {
|
|
|
476
476
|
*/
|
|
477
477
|
export interface CreateAttendeeRequest {
|
|
478
478
|
/**
|
|
479
|
-
* @public
|
|
480
479
|
* <p>The unique ID of the meeting.</p>
|
|
480
|
+
* @public
|
|
481
481
|
*/
|
|
482
482
|
MeetingId: string | undefined;
|
|
483
483
|
/**
|
|
484
|
-
* @public
|
|
485
484
|
* <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
|
|
486
485
|
* <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
|
|
487
486
|
* </p>
|
|
488
487
|
* <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that
|
|
489
488
|
* uses this prefix.</p>
|
|
489
|
+
* @public
|
|
490
490
|
*/
|
|
491
491
|
ExternalUserId: string | undefined;
|
|
492
492
|
/**
|
|
493
|
-
* @public
|
|
494
493
|
* <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
|
|
495
494
|
* all media channels by default.</p>
|
|
496
495
|
* <note>
|
|
@@ -521,6 +520,7 @@ export interface CreateAttendeeRequest {
|
|
|
521
520
|
* and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.</p>
|
|
522
521
|
* </li>
|
|
523
522
|
* </ul>
|
|
523
|
+
* @public
|
|
524
524
|
*/
|
|
525
525
|
Capabilities?: AttendeeCapabilities;
|
|
526
526
|
}
|
|
@@ -529,8 +529,8 @@ export interface CreateAttendeeRequest {
|
|
|
529
529
|
*/
|
|
530
530
|
export interface CreateAttendeeResponse {
|
|
531
531
|
/**
|
|
532
|
-
* @public
|
|
533
532
|
* <p>The attendee information, including attendee ID and join token.</p>
|
|
533
|
+
* @public
|
|
534
534
|
*/
|
|
535
535
|
Attendee?: Attendee;
|
|
536
536
|
}
|
|
@@ -548,21 +548,21 @@ export declare const ContentResolution: {
|
|
|
548
548
|
*/
|
|
549
549
|
export type ContentResolution = (typeof ContentResolution)[keyof typeof ContentResolution];
|
|
550
550
|
/**
|
|
551
|
-
* @public
|
|
552
551
|
* <p>Lists the content (screen share) features for the meeting. Applies to all attendees.</p>
|
|
553
552
|
* <note>
|
|
554
553
|
* <p>If you specify <code>MeetingFeatures:Content:MaxResolution:None</code> when you create a meeting, all API requests that include <code>SendReceive</code>, <code>Send</code>, or
|
|
555
554
|
* <code>Receive</code> for <code>AttendeeCapabilities:Content</code> will be rejected with <code>ValidationError 400</code>.</p>
|
|
556
555
|
* </note>
|
|
556
|
+
* @public
|
|
557
557
|
*/
|
|
558
558
|
export interface ContentFeatures {
|
|
559
559
|
/**
|
|
560
|
-
* @public
|
|
561
560
|
* <p>The maximum resolution for the meeting content.</p>
|
|
562
561
|
* <note>
|
|
563
562
|
* <p>Defaults to <code>FHD</code>. To use <code>UHD</code>, you must also provide a <code>MeetingFeatures:Attendee:MaxCount</code>
|
|
564
563
|
* value and override the default size limit of 250 attendees.</p>
|
|
565
564
|
* </note>
|
|
565
|
+
* @public
|
|
566
566
|
*/
|
|
567
567
|
MaxResolution?: ContentResolution;
|
|
568
568
|
}
|
|
@@ -580,84 +580,84 @@ export declare const VideoResolution: {
|
|
|
580
580
|
*/
|
|
581
581
|
export type VideoResolution = (typeof VideoResolution)[keyof typeof VideoResolution];
|
|
582
582
|
/**
|
|
583
|
-
* @public
|
|
584
583
|
* <p>The video features set for the meeting. Applies to all attendees.</p>
|
|
585
584
|
* <note>
|
|
586
585
|
* <p>If you specify <code>MeetingFeatures:Video:MaxResolution:None</code> when you create a meeting, all API requests
|
|
587
586
|
* that include <code>SendReceive</code>, <code>Send</code>, or <code>Receive</code> for <code>AttendeeCapabilities:Video</code> will be rejected with <code>ValidationError 400</code>.</p>
|
|
588
587
|
* </note>
|
|
588
|
+
* @public
|
|
589
589
|
*/
|
|
590
590
|
export interface VideoFeatures {
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* <p>The maximum video resolution for the meeting. Applies to all attendees.</p>
|
|
594
593
|
* <note>
|
|
595
594
|
* <p>Defaults to <code>HD</code>. To use <code>FHD</code>, you must also provide a <code>MeetingFeatures:Attendee:MaxCount</code> value and override the default size
|
|
596
595
|
* limit of 250 attendees.</p>
|
|
597
596
|
* </note>
|
|
597
|
+
* @public
|
|
598
598
|
*/
|
|
599
599
|
MaxResolution?: VideoResolution;
|
|
600
600
|
}
|
|
601
601
|
/**
|
|
602
|
-
* @public
|
|
603
602
|
* <p>The configuration settings of the features available to a meeting.</p>
|
|
603
|
+
* @public
|
|
604
604
|
*/
|
|
605
605
|
export interface MeetingFeaturesConfiguration {
|
|
606
606
|
/**
|
|
607
|
-
* @public
|
|
608
607
|
* <p>The configuration settings for the audio features available to a meeting.</p>
|
|
608
|
+
* @public
|
|
609
609
|
*/
|
|
610
610
|
Audio?: AudioFeatures;
|
|
611
611
|
/**
|
|
612
|
-
* @public
|
|
613
612
|
* <p>The configuration settings for the video features available to a meeting.</p>
|
|
613
|
+
* @public
|
|
614
614
|
*/
|
|
615
615
|
Video?: VideoFeatures;
|
|
616
616
|
/**
|
|
617
|
-
* @public
|
|
618
617
|
* <p>The configuration settings for the content features available to a meeting.</p>
|
|
618
|
+
* @public
|
|
619
619
|
*/
|
|
620
620
|
Content?: ContentFeatures;
|
|
621
621
|
/**
|
|
622
|
-
* @public
|
|
623
622
|
* <p>The configuration settings for the attendee features available to a meeting.</p>
|
|
623
|
+
* @public
|
|
624
624
|
*/
|
|
625
625
|
Attendee?: AttendeeFeatures;
|
|
626
626
|
}
|
|
627
627
|
/**
|
|
628
|
-
* @public
|
|
629
628
|
* <p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>
|
|
629
|
+
* @public
|
|
630
630
|
*/
|
|
631
631
|
export interface NotificationsConfiguration {
|
|
632
632
|
/**
|
|
633
|
-
* @public
|
|
634
633
|
* <p>The ARN of the Amazon Web Services Lambda function in the notifications configuration.</p>
|
|
634
|
+
* @public
|
|
635
635
|
*/
|
|
636
636
|
LambdaFunctionArn?: string;
|
|
637
637
|
/**
|
|
638
|
-
* @public
|
|
639
638
|
* <p>The ARN of the SNS topic.</p>
|
|
639
|
+
* @public
|
|
640
640
|
*/
|
|
641
641
|
SnsTopicArn?: string;
|
|
642
642
|
/**
|
|
643
|
-
* @public
|
|
644
643
|
* <p>The ARN of the SQS queue.</p>
|
|
644
|
+
* @public
|
|
645
645
|
*/
|
|
646
646
|
SqsQueueArn?: string;
|
|
647
647
|
}
|
|
648
648
|
/**
|
|
649
|
-
* @public
|
|
650
649
|
* <p>A key-value pair that you define.</p>
|
|
650
|
+
* @public
|
|
651
651
|
*/
|
|
652
652
|
export interface Tag {
|
|
653
653
|
/**
|
|
654
|
-
* @public
|
|
655
654
|
* <p>The tag's key.</p>
|
|
655
|
+
* @public
|
|
656
656
|
*/
|
|
657
657
|
Key: string | undefined;
|
|
658
658
|
/**
|
|
659
|
-
* @public
|
|
660
659
|
* <p>The tag's value.</p>
|
|
660
|
+
* @public
|
|
661
661
|
*/
|
|
662
662
|
Value: string | undefined;
|
|
663
663
|
}
|
|
@@ -666,12 +666,11 @@ export interface Tag {
|
|
|
666
666
|
*/
|
|
667
667
|
export interface CreateMeetingRequest {
|
|
668
668
|
/**
|
|
669
|
-
* @public
|
|
670
669
|
* <p>The unique identifier for the client request. Use a different token for different meetings.</p>
|
|
670
|
+
* @public
|
|
671
671
|
*/
|
|
672
672
|
ClientRequestToken?: string;
|
|
673
673
|
/**
|
|
674
|
-
* @public
|
|
675
674
|
* <p>The Region in which to create the meeting.</p>
|
|
676
675
|
* <p>
|
|
677
676
|
* Available values:
|
|
@@ -695,44 +694,44 @@ export interface CreateMeetingRequest {
|
|
|
695
694
|
* <code>us-west-2</code>.
|
|
696
695
|
* </p>
|
|
697
696
|
* <p>Available values in Amazon Web Services GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>
|
|
697
|
+
* @public
|
|
698
698
|
*/
|
|
699
699
|
MediaRegion: string | undefined;
|
|
700
700
|
/**
|
|
701
|
-
* @public
|
|
702
701
|
* <p>Reserved.</p>
|
|
702
|
+
* @public
|
|
703
703
|
*/
|
|
704
704
|
MeetingHostId?: string;
|
|
705
705
|
/**
|
|
706
|
-
* @public
|
|
707
706
|
* <p>The external meeting ID.</p>
|
|
708
707
|
* <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
|
|
709
708
|
* </p>
|
|
710
709
|
* <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
|
|
711
710
|
* Case insensitive.</p>
|
|
711
|
+
* @public
|
|
712
712
|
*/
|
|
713
713
|
ExternalMeetingId: string | undefined;
|
|
714
714
|
/**
|
|
715
|
-
* @public
|
|
716
715
|
* <p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>
|
|
716
|
+
* @public
|
|
717
717
|
*/
|
|
718
718
|
NotificationsConfiguration?: NotificationsConfiguration;
|
|
719
719
|
/**
|
|
720
|
-
* @public
|
|
721
720
|
* <p>Lists the audio and video features enabled for a meeting, such as echo reduction.</p>
|
|
721
|
+
* @public
|
|
722
722
|
*/
|
|
723
723
|
MeetingFeatures?: MeetingFeaturesConfiguration;
|
|
724
724
|
/**
|
|
725
|
-
* @public
|
|
726
725
|
* <p>When specified, replicates the media from the primary meeting to the new meeting.</p>
|
|
726
|
+
* @public
|
|
727
727
|
*/
|
|
728
728
|
PrimaryMeetingId?: string;
|
|
729
729
|
/**
|
|
730
|
-
* @public
|
|
731
730
|
* <p>A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.</p>
|
|
731
|
+
* @public
|
|
732
732
|
*/
|
|
733
733
|
TenantIds?: string[];
|
|
734
734
|
/**
|
|
735
|
-
* @public
|
|
736
735
|
* <p>Applies one or more tags to an Amazon Chime SDK meeting. Note the following:</p>
|
|
737
736
|
* <ul>
|
|
738
737
|
* <li>
|
|
@@ -771,101 +770,101 @@ export interface CreateMeetingRequest {
|
|
|
771
770
|
* <p>Some services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the <code>s3:GetBucketTagging</code> permission.
|
|
772
771
|
* If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.</p>
|
|
773
772
|
* </note>
|
|
773
|
+
* @public
|
|
774
774
|
*/
|
|
775
775
|
Tags?: Tag[];
|
|
776
776
|
}
|
|
777
777
|
/**
|
|
778
|
-
* @public
|
|
779
778
|
* <p>A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.</p>
|
|
779
|
+
* @public
|
|
780
780
|
*/
|
|
781
781
|
export interface MediaPlacement {
|
|
782
782
|
/**
|
|
783
|
-
* @public
|
|
784
783
|
* <p>The audio host URL.</p>
|
|
784
|
+
* @public
|
|
785
785
|
*/
|
|
786
786
|
AudioHostUrl?: string;
|
|
787
787
|
/**
|
|
788
|
-
* @public
|
|
789
788
|
* <p>The audio fallback URL.</p>
|
|
789
|
+
* @public
|
|
790
790
|
*/
|
|
791
791
|
AudioFallbackUrl?: string;
|
|
792
792
|
/**
|
|
793
|
-
* @public
|
|
794
793
|
* <p>The signaling URL.</p>
|
|
794
|
+
* @public
|
|
795
795
|
*/
|
|
796
796
|
SignalingUrl?: string;
|
|
797
797
|
/**
|
|
798
|
-
* @public
|
|
799
798
|
* <p>The turn control URL.</p>
|
|
800
799
|
* <important>
|
|
801
800
|
* <p>
|
|
802
801
|
* <b>This parameter is deprecated and no longer used by the Amazon Chime SDK.</b>
|
|
803
802
|
* </p>
|
|
804
803
|
* </important>
|
|
804
|
+
* @public
|
|
805
805
|
*/
|
|
806
806
|
TurnControlUrl?: string;
|
|
807
807
|
/**
|
|
808
|
-
* @public
|
|
809
808
|
* <p>The screen data URL.</p>
|
|
810
809
|
* <important>
|
|
811
810
|
* <p>
|
|
812
811
|
* <b>This parameter is deprecated and no longer used by the Amazon Chime SDK.</b>
|
|
813
812
|
* </p>
|
|
814
813
|
* </important>
|
|
814
|
+
* @public
|
|
815
815
|
*/
|
|
816
816
|
ScreenDataUrl?: string;
|
|
817
817
|
/**
|
|
818
|
-
* @public
|
|
819
818
|
* <p>The screen viewing URL.</p>
|
|
820
819
|
* <important>
|
|
821
820
|
* <p>
|
|
822
821
|
* <b>This parameter is deprecated and no longer used by the Amazon Chime SDK.</b>
|
|
823
822
|
* </p>
|
|
824
823
|
* </important>
|
|
824
|
+
* @public
|
|
825
825
|
*/
|
|
826
826
|
ScreenViewingUrl?: string;
|
|
827
827
|
/**
|
|
828
|
-
* @public
|
|
829
828
|
* <p>The screen sharing URL.</p>
|
|
830
829
|
* <important>
|
|
831
830
|
* <p>
|
|
832
831
|
* <b>This parameter is deprecated and no longer used by the Amazon Chime SDK.</b>
|
|
833
832
|
* </p>
|
|
834
833
|
* </important>
|
|
834
|
+
* @public
|
|
835
835
|
*/
|
|
836
836
|
ScreenSharingUrl?: string;
|
|
837
837
|
/**
|
|
838
|
-
* @public
|
|
839
838
|
* <p>The event ingestion URL.</p>
|
|
839
|
+
* @public
|
|
840
840
|
*/
|
|
841
841
|
EventIngestionUrl?: string;
|
|
842
842
|
}
|
|
843
843
|
/**
|
|
844
|
-
* @public
|
|
845
844
|
* <p>A meeting created using the Amazon Chime SDK.</p>
|
|
845
|
+
* @public
|
|
846
846
|
*/
|
|
847
847
|
export interface Meeting {
|
|
848
848
|
/**
|
|
849
|
-
* @public
|
|
850
849
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
850
|
+
* @public
|
|
851
851
|
*/
|
|
852
852
|
MeetingId?: string;
|
|
853
853
|
/**
|
|
854
|
-
* @public
|
|
855
854
|
* <p>Reserved.</p>
|
|
855
|
+
* @public
|
|
856
856
|
*/
|
|
857
857
|
MeetingHostId?: string;
|
|
858
858
|
/**
|
|
859
|
-
* @public
|
|
860
859
|
* <p>The external meeting ID.</p>
|
|
861
860
|
* <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
|
|
862
861
|
* </p>
|
|
863
862
|
* <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
|
|
864
863
|
* Case insensitive.</p>
|
|
864
|
+
* @public
|
|
865
865
|
*/
|
|
866
866
|
ExternalMeetingId?: string;
|
|
867
867
|
/**
|
|
868
|
-
* @public
|
|
869
868
|
* <p>The Region in which you create the meeting. Available values: <code>af-south-1</code>, <code>ap-northeast-1</code>,
|
|
870
869
|
* <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>,
|
|
871
870
|
* <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-south-1</code>,
|
|
@@ -873,31 +872,32 @@ export interface Meeting {
|
|
|
873
872
|
* <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>,
|
|
874
873
|
* <code>us-west-1</code>, <code>us-west-2</code>.</p>
|
|
875
874
|
* <p>Available values in Amazon Web Services GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>
|
|
875
|
+
* @public
|
|
876
876
|
*/
|
|
877
877
|
MediaRegion?: string;
|
|
878
878
|
/**
|
|
879
|
-
* @public
|
|
880
879
|
* <p>The media placement for the meeting.</p>
|
|
880
|
+
* @public
|
|
881
881
|
*/
|
|
882
882
|
MediaPlacement?: MediaPlacement;
|
|
883
883
|
/**
|
|
884
|
-
* @public
|
|
885
884
|
* <p>The features available to a meeting, such as echo reduction.</p>
|
|
885
|
+
* @public
|
|
886
886
|
*/
|
|
887
887
|
MeetingFeatures?: MeetingFeaturesConfiguration;
|
|
888
888
|
/**
|
|
889
|
-
* @public
|
|
890
889
|
* <p>When specified, replicates the media from the primary meeting to this meeting.</p>
|
|
890
|
+
* @public
|
|
891
891
|
*/
|
|
892
892
|
PrimaryMeetingId?: string;
|
|
893
893
|
/**
|
|
894
|
-
* @public
|
|
895
894
|
* <p>Array of strings.</p>
|
|
895
|
+
* @public
|
|
896
896
|
*/
|
|
897
897
|
TenantIds?: string[];
|
|
898
898
|
/**
|
|
899
|
-
* @public
|
|
900
899
|
* <p>The ARN of the meeting.</p>
|
|
900
|
+
* @public
|
|
901
901
|
*/
|
|
902
902
|
MeetingArn?: string;
|
|
903
903
|
}
|
|
@@ -906,9 +906,9 @@ export interface Meeting {
|
|
|
906
906
|
*/
|
|
907
907
|
export interface CreateMeetingResponse {
|
|
908
908
|
/**
|
|
909
|
-
* @public
|
|
910
909
|
* <p>The meeting information, including the meeting ID and
|
|
911
910
|
* <code>MediaPlacement</code>.</p>
|
|
911
|
+
* @public
|
|
912
912
|
*/
|
|
913
913
|
Meeting?: Meeting;
|
|
914
914
|
}
|
|
@@ -917,12 +917,11 @@ export interface CreateMeetingResponse {
|
|
|
917
917
|
*/
|
|
918
918
|
export interface CreateMeetingWithAttendeesRequest {
|
|
919
919
|
/**
|
|
920
|
-
* @public
|
|
921
920
|
* <p>The unique identifier for the client request. Use a different token for different meetings.</p>
|
|
921
|
+
* @public
|
|
922
922
|
*/
|
|
923
923
|
ClientRequestToken?: string;
|
|
924
924
|
/**
|
|
925
|
-
* @public
|
|
926
925
|
* <p>The Region in which to create the meeting.</p>
|
|
927
926
|
* <p>
|
|
928
927
|
* Available values:
|
|
@@ -946,50 +945,51 @@ export interface CreateMeetingWithAttendeesRequest {
|
|
|
946
945
|
* <code>us-west-2</code>.
|
|
947
946
|
* </p>
|
|
948
947
|
* <p>Available values in Amazon Web Services GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>
|
|
948
|
+
* @public
|
|
949
949
|
*/
|
|
950
950
|
MediaRegion: string | undefined;
|
|
951
951
|
/**
|
|
952
|
-
* @public
|
|
953
952
|
* <p>Reserved.</p>
|
|
953
|
+
* @public
|
|
954
954
|
*/
|
|
955
955
|
MeetingHostId?: string;
|
|
956
956
|
/**
|
|
957
|
-
* @public
|
|
958
957
|
* <p>The external meeting ID.</p>
|
|
959
958
|
* <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
|
|
960
959
|
* </p>
|
|
961
960
|
* <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
|
|
962
961
|
* Case insensitive.</p>
|
|
962
|
+
* @public
|
|
963
963
|
*/
|
|
964
964
|
ExternalMeetingId: string | undefined;
|
|
965
965
|
/**
|
|
966
|
-
* @public
|
|
967
966
|
* <p>Lists the audio and video features enabled for a meeting, such as echo reduction.</p>
|
|
967
|
+
* @public
|
|
968
968
|
*/
|
|
969
969
|
MeetingFeatures?: MeetingFeaturesConfiguration;
|
|
970
970
|
/**
|
|
971
|
-
* @public
|
|
972
971
|
* <p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>
|
|
972
|
+
* @public
|
|
973
973
|
*/
|
|
974
974
|
NotificationsConfiguration?: NotificationsConfiguration;
|
|
975
975
|
/**
|
|
976
|
-
* @public
|
|
977
976
|
* <p>The attendee information, including attendees' IDs and join tokens.</p>
|
|
977
|
+
* @public
|
|
978
978
|
*/
|
|
979
979
|
Attendees: CreateAttendeeRequestItem[] | undefined;
|
|
980
980
|
/**
|
|
981
|
-
* @public
|
|
982
981
|
* <p>When specified, replicates the media from the primary meeting to the new meeting.</p>
|
|
982
|
+
* @public
|
|
983
983
|
*/
|
|
984
984
|
PrimaryMeetingId?: string;
|
|
985
985
|
/**
|
|
986
|
-
* @public
|
|
987
986
|
* <p>A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.</p>
|
|
987
|
+
* @public
|
|
988
988
|
*/
|
|
989
989
|
TenantIds?: string[];
|
|
990
990
|
/**
|
|
991
|
-
* @public
|
|
992
991
|
* <p>The tags in the request.</p>
|
|
992
|
+
* @public
|
|
993
993
|
*/
|
|
994
994
|
Tags?: Tag[];
|
|
995
995
|
}
|
|
@@ -998,19 +998,19 @@ export interface CreateMeetingWithAttendeesRequest {
|
|
|
998
998
|
*/
|
|
999
999
|
export interface CreateMeetingWithAttendeesResponse {
|
|
1000
1000
|
/**
|
|
1001
|
-
* @public
|
|
1002
1001
|
* <p>The meeting information, including the meeting ID and
|
|
1003
1002
|
* <code>MediaPlacement</code>.</p>
|
|
1003
|
+
* @public
|
|
1004
1004
|
*/
|
|
1005
1005
|
Meeting?: Meeting;
|
|
1006
1006
|
/**
|
|
1007
|
-
* @public
|
|
1008
1007
|
* <p>The attendee information, including attendees' IDs and join tokens.</p>
|
|
1008
|
+
* @public
|
|
1009
1009
|
*/
|
|
1010
1010
|
Attendees?: Attendee[];
|
|
1011
1011
|
/**
|
|
1012
|
-
* @public
|
|
1013
1012
|
* <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>
|
|
1013
|
+
* @public
|
|
1014
1014
|
*/
|
|
1015
1015
|
Errors?: CreateAttendeeError[];
|
|
1016
1016
|
}
|
|
@@ -1019,13 +1019,13 @@ export interface CreateMeetingWithAttendeesResponse {
|
|
|
1019
1019
|
*/
|
|
1020
1020
|
export interface DeleteAttendeeRequest {
|
|
1021
1021
|
/**
|
|
1022
|
-
* @public
|
|
1023
1022
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
1023
|
+
* @public
|
|
1024
1024
|
*/
|
|
1025
1025
|
MeetingId: string | undefined;
|
|
1026
1026
|
/**
|
|
1027
|
-
* @public
|
|
1028
1027
|
* <p>The Amazon Chime SDK attendee ID.</p>
|
|
1028
|
+
* @public
|
|
1029
1029
|
*/
|
|
1030
1030
|
AttendeeId: string | undefined;
|
|
1031
1031
|
}
|
|
@@ -1034,8 +1034,8 @@ export interface DeleteAttendeeRequest {
|
|
|
1034
1034
|
*/
|
|
1035
1035
|
export interface DeleteMeetingRequest {
|
|
1036
1036
|
/**
|
|
1037
|
-
* @public
|
|
1038
1037
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
1038
|
+
* @public
|
|
1039
1039
|
*/
|
|
1040
1040
|
MeetingId: string | undefined;
|
|
1041
1041
|
}
|
|
@@ -1044,13 +1044,13 @@ export interface DeleteMeetingRequest {
|
|
|
1044
1044
|
*/
|
|
1045
1045
|
export interface GetAttendeeRequest {
|
|
1046
1046
|
/**
|
|
1047
|
-
* @public
|
|
1048
1047
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
1048
|
+
* @public
|
|
1049
1049
|
*/
|
|
1050
1050
|
MeetingId: string | undefined;
|
|
1051
1051
|
/**
|
|
1052
|
-
* @public
|
|
1053
1052
|
* <p>The Amazon Chime SDK attendee ID.</p>
|
|
1053
|
+
* @public
|
|
1054
1054
|
*/
|
|
1055
1055
|
AttendeeId: string | undefined;
|
|
1056
1056
|
}
|
|
@@ -1059,8 +1059,8 @@ export interface GetAttendeeRequest {
|
|
|
1059
1059
|
*/
|
|
1060
1060
|
export interface GetAttendeeResponse {
|
|
1061
1061
|
/**
|
|
1062
|
-
* @public
|
|
1063
1062
|
* <p>The Amazon Chime SDK attendee information.</p>
|
|
1063
|
+
* @public
|
|
1064
1064
|
*/
|
|
1065
1065
|
Attendee?: Attendee;
|
|
1066
1066
|
}
|
|
@@ -1069,8 +1069,8 @@ export interface GetAttendeeResponse {
|
|
|
1069
1069
|
*/
|
|
1070
1070
|
export interface GetMeetingRequest {
|
|
1071
1071
|
/**
|
|
1072
|
-
* @public
|
|
1073
1072
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
1073
|
+
* @public
|
|
1074
1074
|
*/
|
|
1075
1075
|
MeetingId: string | undefined;
|
|
1076
1076
|
}
|
|
@@ -1079,8 +1079,8 @@ export interface GetMeetingRequest {
|
|
|
1079
1079
|
*/
|
|
1080
1080
|
export interface GetMeetingResponse {
|
|
1081
1081
|
/**
|
|
1082
|
-
* @public
|
|
1083
1082
|
* <p>The Amazon Chime SDK meeting information.</p>
|
|
1083
|
+
* @public
|
|
1084
1084
|
*/
|
|
1085
1085
|
Meeting?: Meeting;
|
|
1086
1086
|
}
|
|
@@ -1089,18 +1089,18 @@ export interface GetMeetingResponse {
|
|
|
1089
1089
|
*/
|
|
1090
1090
|
export interface ListAttendeesRequest {
|
|
1091
1091
|
/**
|
|
1092
|
-
* @public
|
|
1093
1092
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
1093
|
+
* @public
|
|
1094
1094
|
*/
|
|
1095
1095
|
MeetingId: string | undefined;
|
|
1096
1096
|
/**
|
|
1097
|
-
* @public
|
|
1098
1097
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1098
|
+
* @public
|
|
1099
1099
|
*/
|
|
1100
1100
|
NextToken?: string;
|
|
1101
1101
|
/**
|
|
1102
|
-
* @public
|
|
1103
1102
|
* <p>The maximum number of results to return in a single call.</p>
|
|
1103
|
+
* @public
|
|
1104
1104
|
*/
|
|
1105
1105
|
MaxResults?: number;
|
|
1106
1106
|
}
|
|
@@ -1109,13 +1109,13 @@ export interface ListAttendeesRequest {
|
|
|
1109
1109
|
*/
|
|
1110
1110
|
export interface ListAttendeesResponse {
|
|
1111
1111
|
/**
|
|
1112
|
-
* @public
|
|
1113
1112
|
* <p>The Amazon Chime SDK attendee information.</p>
|
|
1113
|
+
* @public
|
|
1114
1114
|
*/
|
|
1115
1115
|
Attendees?: Attendee[];
|
|
1116
1116
|
/**
|
|
1117
|
-
* @public
|
|
1118
1117
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1118
|
+
* @public
|
|
1119
1119
|
*/
|
|
1120
1120
|
NextToken?: string;
|
|
1121
1121
|
}
|
|
@@ -1124,8 +1124,8 @@ export interface ListAttendeesResponse {
|
|
|
1124
1124
|
*/
|
|
1125
1125
|
export interface ListTagsForResourceRequest {
|
|
1126
1126
|
/**
|
|
1127
|
-
* @public
|
|
1128
1127
|
* <p>The ARN of the resource.</p>
|
|
1128
|
+
* @public
|
|
1129
1129
|
*/
|
|
1130
1130
|
ResourceARN: string | undefined;
|
|
1131
1131
|
}
|
|
@@ -1134,14 +1134,14 @@ export interface ListTagsForResourceRequest {
|
|
|
1134
1134
|
*/
|
|
1135
1135
|
export interface ListTagsForResourceResponse {
|
|
1136
1136
|
/**
|
|
1137
|
-
* @public
|
|
1138
1137
|
* <p>The tags requested for the specified resource.</p>
|
|
1138
|
+
* @public
|
|
1139
1139
|
*/
|
|
1140
1140
|
Tags?: Tag[];
|
|
1141
1141
|
}
|
|
1142
1142
|
/**
|
|
1143
|
-
* @public
|
|
1144
1143
|
* <p>The resource that you want to tag couldn't be found.</p>
|
|
1144
|
+
* @public
|
|
1145
1145
|
*/
|
|
1146
1146
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
1147
1147
|
readonly name: "ResourceNotFoundException";
|
|
@@ -1149,13 +1149,13 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
1149
1149
|
Code?: string;
|
|
1150
1150
|
Message?: string;
|
|
1151
1151
|
/**
|
|
1152
|
-
* @public
|
|
1153
1152
|
* <p>The ID of the resource that couldn't be found.</p>
|
|
1153
|
+
* @public
|
|
1154
1154
|
*/
|
|
1155
1155
|
RequestId?: string;
|
|
1156
1156
|
/**
|
|
1157
|
-
* @public
|
|
1158
1157
|
* <p>The name of the resource that couldn't be found.</p>
|
|
1158
|
+
* @public
|
|
1159
1159
|
*/
|
|
1160
1160
|
ResourceName?: string;
|
|
1161
1161
|
/**
|
|
@@ -1231,38 +1231,38 @@ export declare const TranscribeMedicalType: {
|
|
|
1231
1231
|
*/
|
|
1232
1232
|
export type TranscribeMedicalType = (typeof TranscribeMedicalType)[keyof typeof TranscribeMedicalType];
|
|
1233
1233
|
/**
|
|
1234
|
-
* @public
|
|
1235
1234
|
* <p>Settings specific to the Amazon Transcribe Medical engine.</p>
|
|
1235
|
+
* @public
|
|
1236
1236
|
*/
|
|
1237
1237
|
export interface EngineTranscribeMedicalSettings {
|
|
1238
1238
|
/**
|
|
1239
|
-
* @public
|
|
1240
1239
|
* <p>The language code specified for the Amazon Transcribe Medical engine.</p>
|
|
1240
|
+
* @public
|
|
1241
1241
|
*/
|
|
1242
1242
|
LanguageCode: TranscribeMedicalLanguageCode | undefined;
|
|
1243
1243
|
/**
|
|
1244
|
-
* @public
|
|
1245
1244
|
* <p>The specialty specified for the Amazon Transcribe Medical engine.</p>
|
|
1245
|
+
* @public
|
|
1246
1246
|
*/
|
|
1247
1247
|
Specialty: TranscribeMedicalSpecialty | undefined;
|
|
1248
1248
|
/**
|
|
1249
|
-
* @public
|
|
1250
1249
|
* <p>The type of transcription.</p>
|
|
1250
|
+
* @public
|
|
1251
1251
|
*/
|
|
1252
1252
|
Type: TranscribeMedicalType | undefined;
|
|
1253
1253
|
/**
|
|
1254
|
-
* @public
|
|
1255
1254
|
* <p>The name of the vocabulary passed to Amazon Transcribe Medical.</p>
|
|
1255
|
+
* @public
|
|
1256
1256
|
*/
|
|
1257
1257
|
VocabularyName?: string;
|
|
1258
1258
|
/**
|
|
1259
|
-
* @public
|
|
1260
1259
|
* <p>The Amazon Web Services Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region. </p>
|
|
1260
|
+
* @public
|
|
1261
1261
|
*/
|
|
1262
1262
|
Region?: TranscribeMedicalRegion;
|
|
1263
1263
|
/**
|
|
1264
|
-
* @public
|
|
1265
1264
|
* <p>Set this field to <code>PHI</code> to identify personal health information in the transcription output.</p>
|
|
1265
|
+
* @public
|
|
1266
1266
|
*/
|
|
1267
1267
|
ContentIdentificationType?: TranscribeMedicalContentIdentificationType;
|
|
1268
1268
|
}
|
|
@@ -1362,110 +1362,109 @@ export declare const TranscribeVocabularyFilterMethod: {
|
|
|
1362
1362
|
*/
|
|
1363
1363
|
export type TranscribeVocabularyFilterMethod = (typeof TranscribeVocabularyFilterMethod)[keyof typeof TranscribeVocabularyFilterMethod];
|
|
1364
1364
|
/**
|
|
1365
|
-
* @public
|
|
1366
1365
|
* <p>Settings specific for Amazon Transcribe as the live transcription engine. </p>
|
|
1367
1366
|
* <p>If you specify an invalid combination of parameters, a <code>TranscriptFailed</code> event will be sent with the contents of the
|
|
1368
1367
|
* <code>BadRequestException</code> generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the
|
|
1369
1368
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html">StartStreamTranscription</a> API in the
|
|
1370
1369
|
* <i>Amazon Transcribe Developer Guide</i>.</p>
|
|
1370
|
+
* @public
|
|
1371
1371
|
*/
|
|
1372
1372
|
export interface EngineTranscribeSettings {
|
|
1373
1373
|
/**
|
|
1374
|
-
* @public
|
|
1375
1374
|
* <p>Specify the language code that represents the language spoken.</p>
|
|
1376
1375
|
* <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p>
|
|
1376
|
+
* @public
|
|
1377
1377
|
*/
|
|
1378
1378
|
LanguageCode?: TranscribeLanguageCode;
|
|
1379
1379
|
/**
|
|
1380
|
-
* @public
|
|
1381
1380
|
* <p>Specify how you want your vocabulary filter applied to your transcript.</p>
|
|
1382
1381
|
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
1383
1382
|
* <p>To delete words, choose <code>remove</code>.</p>
|
|
1384
1383
|
* <p>To flag words without changing them, choose <code>tag</code>.</p>
|
|
1384
|
+
* @public
|
|
1385
1385
|
*/
|
|
1386
1386
|
VocabularyFilterMethod?: TranscribeVocabularyFilterMethod;
|
|
1387
1387
|
/**
|
|
1388
|
-
* @public
|
|
1389
1388
|
* <p>Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive. </p>
|
|
1390
1389
|
* <p>If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.</p>
|
|
1391
1390
|
* <p>If you include <code>IdentifyLanguage</code> and want to use one or more vocabulary filters with your transcription, use the <code>VocabularyFilterNames</code> parameter instead.</p>
|
|
1391
|
+
* @public
|
|
1392
1392
|
*/
|
|
1393
1393
|
VocabularyFilterName?: string;
|
|
1394
1394
|
/**
|
|
1395
|
-
* @public
|
|
1396
1395
|
* <p>Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</p>
|
|
1397
1396
|
* <p>If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.</p>
|
|
1398
1397
|
* <p>If you include <code>IdentifyLanguage</code> and want to use one or more custom vocabularies with your transcription, use the <code>VocabularyNames</code>
|
|
1399
1398
|
* parameter instead.</p>
|
|
1399
|
+
* @public
|
|
1400
1400
|
*/
|
|
1401
1401
|
VocabularyName?: string;
|
|
1402
1402
|
/**
|
|
1403
|
-
* @public
|
|
1404
1403
|
* <p>The Amazon Web Services Region in which to use Amazon Transcribe.</p>
|
|
1405
1404
|
* <p>If you don't specify a Region, then the <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html">MediaRegion</a> of the meeting is used.
|
|
1406
1405
|
* However, if Amazon Transcribe is not available in the <code>MediaRegion</code>, then a <code>TranscriptFailed</code> event is sent.</p>
|
|
1407
1406
|
* <p>Use <code>auto</code> to use Amazon Transcribe in a Region near the meeting’s <code>MediaRegion</code>. For more information, refer to
|
|
1408
1407
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/transcription-options.html#choose-region">Choosing a transcription Region</a> in the
|
|
1409
1408
|
* <i>Amazon Chime SDK Developer Guide</i>.</p>
|
|
1409
|
+
* @public
|
|
1410
1410
|
*/
|
|
1411
1411
|
Region?: TranscribeRegion;
|
|
1412
1412
|
/**
|
|
1413
|
-
* @public
|
|
1414
1413
|
* <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.</p>
|
|
1414
|
+
* @public
|
|
1415
1415
|
*/
|
|
1416
1416
|
EnablePartialResultsStabilization?: boolean;
|
|
1417
1417
|
/**
|
|
1418
|
-
* @public
|
|
1419
1418
|
* <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
|
|
1420
1419
|
* <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
|
|
1420
|
+
* @public
|
|
1421
1421
|
*/
|
|
1422
1422
|
PartialResultsStability?: TranscribePartialResultsStability;
|
|
1423
1423
|
/**
|
|
1424
|
-
* @public
|
|
1425
1424
|
* <p>Labels all personally identifiable information (PII) identified in your transcript. If you don't include <code>PiiEntityTypes</code>, all PII is identified.</p>
|
|
1426
1425
|
* <note>
|
|
1427
1426
|
* <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code>.</p>
|
|
1428
1427
|
* </note>
|
|
1428
|
+
* @public
|
|
1429
1429
|
*/
|
|
1430
1430
|
ContentIdentificationType?: TranscribeContentIdentificationType;
|
|
1431
1431
|
/**
|
|
1432
|
-
* @public
|
|
1433
1432
|
* <p>Content redaction is performed at the segment level. If you don't include <code>PiiEntityTypes</code>, all PII is redacted.</p>
|
|
1434
1433
|
* <note>
|
|
1435
1434
|
* <p>You can’t set <code>ContentRedactionType</code> and <code>ContentIdentificationType</code>.</p>
|
|
1436
1435
|
* </note>
|
|
1436
|
+
* @public
|
|
1437
1437
|
*/
|
|
1438
1438
|
ContentRedactionType?: TranscribeContentRedactionType;
|
|
1439
1439
|
/**
|
|
1440
|
-
* @public
|
|
1441
1440
|
* <p>Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select <code>ALL</code>.</p>
|
|
1442
1441
|
* <p>Values must be comma-separated and can include: <code>ADDRESS</code>, <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>
|
|
1443
1442
|
* <code>CREDIT_DEBIT_NUMBER</code>, <code>EMAIL</code>,<code>NAME</code>, <code>PHONE</code>, <code>PIN</code>,
|
|
1444
1443
|
* <code>SSN</code>, or <code>ALL</code>.</p>
|
|
1445
1444
|
* <p>Note that if you include <code>PiiEntityTypes</code>, you must also include <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
|
|
1446
1445
|
* <p>If you include <code>ContentRedactionType</code> or <code>ContentIdentificationType</code>, but do not include PiiEntityTypes, all PII is redacted or identified.</p>
|
|
1446
|
+
* @public
|
|
1447
1447
|
*/
|
|
1448
1448
|
PiiEntityTypes?: string;
|
|
1449
1449
|
/**
|
|
1450
|
-
* @public
|
|
1451
1450
|
* <p>Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.</p>
|
|
1452
1451
|
* <p>The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with
|
|
1453
1452
|
* a language mismatch.</p>
|
|
1454
1453
|
* <p>If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.</p>
|
|
1454
|
+
* @public
|
|
1455
1455
|
*/
|
|
1456
1456
|
LanguageModelName?: string;
|
|
1457
1457
|
/**
|
|
1458
|
-
* @public
|
|
1459
1458
|
* <p>Enables automatic language identification for your transcription.</p>
|
|
1460
1459
|
* <p>If you include <code>IdentifyLanguage</code>, you can optionally use <code>LanguageOptions</code> to include a list of language codes that you think may be present in your audio stream.
|
|
1461
1460
|
* Including language options can improve transcription accuracy.</p>
|
|
1462
1461
|
* <p>You can also use <code>PreferredLanguage</code> to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.</p>
|
|
1463
1462
|
* <p>You must include either <code>LanguageCode</code> or <code>IdentifyLanguage</code>.</p>
|
|
1464
1463
|
* <p>Language identification can't be combined with custom language models or redaction.</p>
|
|
1464
|
+
* @public
|
|
1465
1465
|
*/
|
|
1466
1466
|
IdentifyLanguage?: boolean;
|
|
1467
1467
|
/**
|
|
1468
|
-
* @public
|
|
1469
1468
|
* <p>Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages
|
|
1470
1469
|
* are present, do not include this parameter.</p>
|
|
1471
1470
|
* <p>Including language options can improve the accuracy of language identification.</p>
|
|
@@ -1473,43 +1472,44 @@ export interface EngineTranscribeSettings {
|
|
|
1473
1472
|
* <important>
|
|
1474
1473
|
* <p>You can only include one language dialect per language. For example, you cannot include <code>en-US</code> and <code>en-AU</code>.</p>
|
|
1475
1474
|
* </important>
|
|
1475
|
+
* @public
|
|
1476
1476
|
*/
|
|
1477
1477
|
LanguageOptions?: string;
|
|
1478
1478
|
/**
|
|
1479
|
-
* @public
|
|
1480
1479
|
* <p>Specify a preferred language from the subset of languages codes you specified in <code>LanguageOptions</code>.</p>
|
|
1481
1480
|
* <p>You can only use this parameter if you include <code>IdentifyLanguage</code> and <code>LanguageOptions</code>.</p>
|
|
1481
|
+
* @public
|
|
1482
1482
|
*/
|
|
1483
1483
|
PreferredLanguage?: TranscribeLanguageCode;
|
|
1484
1484
|
/**
|
|
1485
|
-
* @public
|
|
1486
1485
|
* <p>Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</p>
|
|
1487
1486
|
* <p>If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.</p>
|
|
1488
1487
|
* <p>If you don't include <code>IdentifyLanguage</code> and want to use a custom vocabulary with your transcription, use the <code>VocabularyName</code> parameter instead.</p>
|
|
1488
|
+
* @public
|
|
1489
1489
|
*/
|
|
1490
1490
|
VocabularyNames?: string;
|
|
1491
1491
|
/**
|
|
1492
|
-
* @public
|
|
1493
1492
|
* <p>Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.</p>
|
|
1494
1493
|
* <p>If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.</p>
|
|
1495
1494
|
* <p> If you're <i>not</i> including <code>IdentifyLanguage</code> and want to use a custom vocabulary filter with your transcription, use the <code>VocabularyFilterName</code>
|
|
1496
1495
|
* parameter instead.</p>
|
|
1496
|
+
* @public
|
|
1497
1497
|
*/
|
|
1498
1498
|
VocabularyFilterNames?: string;
|
|
1499
1499
|
}
|
|
1500
1500
|
/**
|
|
1501
|
-
* @public
|
|
1502
1501
|
* <p>The configuration for the current transcription operation. Must contain <code>EngineTranscribeSettings</code> or <code>EngineTranscribeMedicalSettings</code>.</p>
|
|
1502
|
+
* @public
|
|
1503
1503
|
*/
|
|
1504
1504
|
export interface TranscriptionConfiguration {
|
|
1505
1505
|
/**
|
|
1506
|
-
* @public
|
|
1507
1506
|
* <p>The transcription configuration settings passed to Amazon Transcribe.</p>
|
|
1507
|
+
* @public
|
|
1508
1508
|
*/
|
|
1509
1509
|
EngineTranscribeSettings?: EngineTranscribeSettings;
|
|
1510
1510
|
/**
|
|
1511
|
-
* @public
|
|
1512
1511
|
* <p>The transcription configuration settings passed to Amazon Transcribe Medical.</p>
|
|
1512
|
+
* @public
|
|
1513
1513
|
*/
|
|
1514
1514
|
EngineTranscribeMedicalSettings?: EngineTranscribeMedicalSettings;
|
|
1515
1515
|
}
|
|
@@ -1518,14 +1518,14 @@ export interface TranscriptionConfiguration {
|
|
|
1518
1518
|
*/
|
|
1519
1519
|
export interface StartMeetingTranscriptionRequest {
|
|
1520
1520
|
/**
|
|
1521
|
-
* @public
|
|
1522
1521
|
* <p>The unique ID of the meeting being transcribed.</p>
|
|
1522
|
+
* @public
|
|
1523
1523
|
*/
|
|
1524
1524
|
MeetingId: string | undefined;
|
|
1525
1525
|
/**
|
|
1526
|
-
* @public
|
|
1527
1526
|
* <p>The configuration for the current transcription operation. Must contain <code>EngineTranscribeSettings</code> or
|
|
1528
1527
|
* <code>EngineTranscribeMedicalSettings</code>.</p>
|
|
1528
|
+
* @public
|
|
1529
1529
|
*/
|
|
1530
1530
|
TranscriptionConfiguration: TranscriptionConfiguration | undefined;
|
|
1531
1531
|
}
|
|
@@ -1534,8 +1534,8 @@ export interface StartMeetingTranscriptionRequest {
|
|
|
1534
1534
|
*/
|
|
1535
1535
|
export interface StopMeetingTranscriptionRequest {
|
|
1536
1536
|
/**
|
|
1537
|
-
* @public
|
|
1538
1537
|
* <p>The unique ID of the meeting for which you stop transcription.</p>
|
|
1538
|
+
* @public
|
|
1539
1539
|
*/
|
|
1540
1540
|
MeetingId: string | undefined;
|
|
1541
1541
|
}
|
|
@@ -1544,13 +1544,13 @@ export interface StopMeetingTranscriptionRequest {
|
|
|
1544
1544
|
*/
|
|
1545
1545
|
export interface TagResourceRequest {
|
|
1546
1546
|
/**
|
|
1547
|
-
* @public
|
|
1548
1547
|
* <p>The ARN of the resource.</p>
|
|
1548
|
+
* @public
|
|
1549
1549
|
*/
|
|
1550
1550
|
ResourceARN: string | undefined;
|
|
1551
1551
|
/**
|
|
1552
|
-
* @public
|
|
1553
1552
|
* <p>Lists the requested tags.</p>
|
|
1553
|
+
* @public
|
|
1554
1554
|
*/
|
|
1555
1555
|
Tags: Tag[] | undefined;
|
|
1556
1556
|
}
|
|
@@ -1560,8 +1560,8 @@ export interface TagResourceRequest {
|
|
|
1560
1560
|
export interface TagResourceResponse {
|
|
1561
1561
|
}
|
|
1562
1562
|
/**
|
|
1563
|
-
* @public
|
|
1564
1563
|
* <p>Too many tags were added to the specified resource.</p>
|
|
1564
|
+
* @public
|
|
1565
1565
|
*/
|
|
1566
1566
|
export declare class TooManyTagsException extends __BaseException {
|
|
1567
1567
|
readonly name: "TooManyTagsException";
|
|
@@ -1569,13 +1569,13 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
1569
1569
|
Code?: string;
|
|
1570
1570
|
Message?: string;
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>The ID of the request that contains too many tags.</p>
|
|
1573
|
+
* @public
|
|
1574
1574
|
*/
|
|
1575
1575
|
RequestId?: string;
|
|
1576
1576
|
/**
|
|
1577
|
-
* @public
|
|
1578
1577
|
* <p>The name of the resource that received too many tags.</p>
|
|
1578
|
+
* @public
|
|
1579
1579
|
*/
|
|
1580
1580
|
ResourceName?: string;
|
|
1581
1581
|
/**
|
|
@@ -1588,13 +1588,13 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
1588
1588
|
*/
|
|
1589
1589
|
export interface UntagResourceRequest {
|
|
1590
1590
|
/**
|
|
1591
|
-
* @public
|
|
1592
1591
|
* <p>The ARN of the resource that you're removing tags from.</p>
|
|
1592
|
+
* @public
|
|
1593
1593
|
*/
|
|
1594
1594
|
ResourceARN: string | undefined;
|
|
1595
1595
|
/**
|
|
1596
|
-
* @public
|
|
1597
1596
|
* <p>The tag keys being removed from the resources.</p>
|
|
1597
|
+
* @public
|
|
1598
1598
|
*/
|
|
1599
1599
|
TagKeys: string[] | undefined;
|
|
1600
1600
|
}
|
|
@@ -1608,18 +1608,18 @@ export interface UntagResourceResponse {
|
|
|
1608
1608
|
*/
|
|
1609
1609
|
export interface UpdateAttendeeCapabilitiesRequest {
|
|
1610
1610
|
/**
|
|
1611
|
-
* @public
|
|
1612
1611
|
* <p>The ID of the meeting associated with the update request.</p>
|
|
1612
|
+
* @public
|
|
1613
1613
|
*/
|
|
1614
1614
|
MeetingId: string | undefined;
|
|
1615
1615
|
/**
|
|
1616
|
-
* @public
|
|
1617
1616
|
* <p>The ID of the attendee associated with the update request.</p>
|
|
1617
|
+
* @public
|
|
1618
1618
|
*/
|
|
1619
1619
|
AttendeeId: string | undefined;
|
|
1620
1620
|
/**
|
|
1621
|
-
* @public
|
|
1622
1621
|
* <p>The capabilities that you want to update.</p>
|
|
1622
|
+
* @public
|
|
1623
1623
|
*/
|
|
1624
1624
|
Capabilities: AttendeeCapabilities | undefined;
|
|
1625
1625
|
}
|
|
@@ -1628,8 +1628,8 @@ export interface UpdateAttendeeCapabilitiesRequest {
|
|
|
1628
1628
|
*/
|
|
1629
1629
|
export interface UpdateAttendeeCapabilitiesResponse {
|
|
1630
1630
|
/**
|
|
1631
|
-
* @public
|
|
1632
1631
|
* <p>The updated attendee data.</p>
|
|
1632
|
+
* @public
|
|
1633
1633
|
*/
|
|
1634
1634
|
Attendee?: Attendee;
|
|
1635
1635
|
}
|