@aws-sdk/client-ivs-realtime 3.758.0 → 3.763.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.
Files changed (9) hide show
  1. package/dist-cjs/index.js +422 -7
  2. package/dist-es/models/models_0.js +112 -0
  3. package/dist-es/protocols/Aws_restJson1.js +86 -7
  4. package/dist-types/commands/CreateStageCommand.d.ts +2 -0
  5. package/dist-types/commands/GetStageCommand.d.ts +1 -0
  6. package/dist-types/commands/UpdateStageCommand.d.ts +2 -0
  7. package/dist-types/models/models_0.d.ts +504 -172
  8. package/dist-types/ts3.4/models/models_0.d.ts +57 -0
  9. package/package.json +1 -1
package/dist-types/models/models_0.d.ts CHANGED
@@ -7,6 +7,46 @@ import { IVSRealTimeServiceException as __BaseException } from "./IVSRealTimeSer
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
9
9
  readonly $fault: "client";
10
+ /**
11
+ * <p/>
12
+ * @public
13
+ */
14
+ accessControlAllowOrigin?: string | undefined;
15
+ /**
16
+ * <p/>
17
+ * @public
18
+ */
19
+ accessControlExposeHeaders?: string | undefined;
20
+ /**
21
+ * <p/>
22
+ * @public
23
+ */
24
+ cacheControl?: string | undefined;
25
+ /**
26
+ * <p/>
27
+ * @public
28
+ */
29
+ contentSecurityPolicy?: string | undefined;
30
+ /**
31
+ * <p/>
32
+ * @public
33
+ */
34
+ strictTransportSecurity?: string | undefined;
35
+ /**
36
+ * <p/>
37
+ * @public
38
+ */
39
+ xContentTypeOptions?: string | undefined;
40
+ /**
41
+ * <p/>
42
+ * @public
43
+ */
44
+ xFrameOptions?: string | undefined;
45
+ /**
46
+ * <p/>
47
+ * @public
48
+ */
49
+ xAmznErrorType?: string | undefined;
10
50
  /**
11
51
  * <p>User does not have sufficient access to perform this action.</p>
12
52
  * @public
@@ -24,6 +64,46 @@ export declare class AccessDeniedException extends __BaseException {
24
64
  export declare class ConflictException extends __BaseException {
25
65
  readonly name: "ConflictException";
26
66
  readonly $fault: "client";
67
+ /**
68
+ * <p/>
69
+ * @public
70
+ */
71
+ accessControlAllowOrigin?: string | undefined;
72
+ /**
73
+ * <p/>
74
+ * @public
75
+ */
76
+ accessControlExposeHeaders?: string | undefined;
77
+ /**
78
+ * <p/>
79
+ * @public
80
+ */
81
+ cacheControl?: string | undefined;
82
+ /**
83
+ * <p/>
84
+ * @public
85
+ */
86
+ contentSecurityPolicy?: string | undefined;
87
+ /**
88
+ * <p/>
89
+ * @public
90
+ */
91
+ strictTransportSecurity?: string | undefined;
92
+ /**
93
+ * <p/>
94
+ * @public
95
+ */
96
+ xContentTypeOptions?: string | undefined;
97
+ /**
98
+ * <p/>
99
+ * @public
100
+ */
101
+ xFrameOptions?: string | undefined;
102
+ /**
103
+ * <p/>
104
+ * @public
105
+ */
106
+ xAmznErrorType?: string | undefined;
27
107
  /**
28
108
  * <p>Updating or deleting a resource can cause an inconsistent state.</p>
29
109
  * @public
@@ -40,16 +120,16 @@ export declare class ConflictException extends __BaseException {
40
120
  */
41
121
  export interface Video {
42
122
  /**
43
- * <p>Video-resolution width. This must be an even number. Note that the maximum value is determined by <code>width</code>
44
- * times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or
45
- * 1080x1920). Default: 1280.</p>
123
+ * <p>Video-resolution width. This must be an even number. Note that the maximum value is
124
+ * determined by <code>width</code> times <code>height</code>, such that the maximum total
125
+ * pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.</p>
46
126
  * @public
47
127
  */
48
128
  width?: number | undefined;
49
129
  /**
50
- * <p>Video-resolution height. This must be an even number. Note that the maximum value is determined by <code>width</code>
51
- * times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or
52
- * 1080x1920). Default: 720.</p>
130
+ * <p>Video-resolution height. This must be an even number. Note that the maximum value is
131
+ * determined by <code>width</code> times <code>height</code>, such that the maximum total
132
+ * pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.</p>
53
133
  * @public
54
134
  */
55
135
  height?: number | undefined;
@@ -112,9 +192,10 @@ export interface EncoderConfiguration {
112
192
  video?: Video | undefined;
113
193
  /**
114
194
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
115
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
116
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
117
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
195
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag
196
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
197
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
198
+ * there.</p>
118
199
  * @public
119
200
  */
120
201
  tags?: Record<string, string> | undefined;
@@ -136,6 +217,46 @@ export interface CreateEncoderConfigurationResponse {
136
217
  export declare class InternalServerException extends __BaseException {
137
218
  readonly name: "InternalServerException";
138
219
  readonly $fault: "server";
220
+ /**
221
+ * <p/>
222
+ * @public
223
+ */
224
+ accessControlAllowOrigin?: string | undefined;
225
+ /**
226
+ * <p/>
227
+ * @public
228
+ */
229
+ accessControlExposeHeaders?: string | undefined;
230
+ /**
231
+ * <p/>
232
+ * @public
233
+ */
234
+ cacheControl?: string | undefined;
235
+ /**
236
+ * <p/>
237
+ * @public
238
+ */
239
+ contentSecurityPolicy?: string | undefined;
240
+ /**
241
+ * <p/>
242
+ * @public
243
+ */
244
+ strictTransportSecurity?: string | undefined;
245
+ /**
246
+ * <p/>
247
+ * @public
248
+ */
249
+ xContentTypeOptions?: string | undefined;
250
+ /**
251
+ * <p/>
252
+ * @public
253
+ */
254
+ xFrameOptions?: string | undefined;
255
+ /**
256
+ * <p/>
257
+ * @public
258
+ */
259
+ xAmznErrorType?: string | undefined;
139
260
  /**
140
261
  * <p>Unexpected error during processing of request.</p>
141
262
  * @public
@@ -153,6 +274,46 @@ export declare class InternalServerException extends __BaseException {
153
274
  export declare class PendingVerification extends __BaseException {
154
275
  readonly name: "PendingVerification";
155
276
  readonly $fault: "client";
277
+ /**
278
+ * <p/>
279
+ * @public
280
+ */
281
+ accessControlAllowOrigin?: string | undefined;
282
+ /**
283
+ * <p/>
284
+ * @public
285
+ */
286
+ accessControlExposeHeaders?: string | undefined;
287
+ /**
288
+ * <p/>
289
+ * @public
290
+ */
291
+ cacheControl?: string | undefined;
292
+ /**
293
+ * <p/>
294
+ * @public
295
+ */
296
+ contentSecurityPolicy?: string | undefined;
297
+ /**
298
+ * <p/>
299
+ * @public
300
+ */
301
+ strictTransportSecurity?: string | undefined;
302
+ /**
303
+ * <p/>
304
+ * @public
305
+ */
306
+ xContentTypeOptions?: string | undefined;
307
+ /**
308
+ * <p/>
309
+ * @public
310
+ */
311
+ xFrameOptions?: string | undefined;
312
+ /**
313
+ * <p/>
314
+ * @public
315
+ */
316
+ xAmznErrorType?: string | undefined;
156
317
  /**
157
318
  * <p> Your account is pending verification. </p>
158
319
  * @public
@@ -170,6 +331,46 @@ export declare class PendingVerification extends __BaseException {
170
331
  export declare class ResourceNotFoundException extends __BaseException {
171
332
  readonly name: "ResourceNotFoundException";
172
333
  readonly $fault: "client";
334
+ /**
335
+ * <p/>
336
+ * @public
337
+ */
338
+ accessControlAllowOrigin?: string | undefined;
339
+ /**
340
+ * <p/>
341
+ * @public
342
+ */
343
+ accessControlExposeHeaders?: string | undefined;
344
+ /**
345
+ * <p/>
346
+ * @public
347
+ */
348
+ cacheControl?: string | undefined;
349
+ /**
350
+ * <p/>
351
+ * @public
352
+ */
353
+ contentSecurityPolicy?: string | undefined;
354
+ /**
355
+ * <p/>
356
+ * @public
357
+ */
358
+ strictTransportSecurity?: string | undefined;
359
+ /**
360
+ * <p/>
361
+ * @public
362
+ */
363
+ xContentTypeOptions?: string | undefined;
364
+ /**
365
+ * <p/>
366
+ * @public
367
+ */
368
+ xFrameOptions?: string | undefined;
369
+ /**
370
+ * <p/>
371
+ * @public
372
+ */
373
+ xAmznErrorType?: string | undefined;
173
374
  /**
174
375
  * <p>Request references a resource which does not exist.</p>
175
376
  * @public
@@ -187,6 +388,46 @@ export declare class ResourceNotFoundException extends __BaseException {
187
388
  export declare class ServiceQuotaExceededException extends __BaseException {
188
389
  readonly name: "ServiceQuotaExceededException";
189
390
  readonly $fault: "client";
391
+ /**
392
+ * <p/>
393
+ * @public
394
+ */
395
+ accessControlAllowOrigin?: string | undefined;
396
+ /**
397
+ * <p/>
398
+ * @public
399
+ */
400
+ accessControlExposeHeaders?: string | undefined;
401
+ /**
402
+ * <p/>
403
+ * @public
404
+ */
405
+ cacheControl?: string | undefined;
406
+ /**
407
+ * <p/>
408
+ * @public
409
+ */
410
+ contentSecurityPolicy?: string | undefined;
411
+ /**
412
+ * <p/>
413
+ * @public
414
+ */
415
+ strictTransportSecurity?: string | undefined;
416
+ /**
417
+ * <p/>
418
+ * @public
419
+ */
420
+ xContentTypeOptions?: string | undefined;
421
+ /**
422
+ * <p/>
423
+ * @public
424
+ */
425
+ xFrameOptions?: string | undefined;
426
+ /**
427
+ * <p/>
428
+ * @public
429
+ */
430
+ xAmznErrorType?: string | undefined;
190
431
  /**
191
432
  * <p>Request would cause a service quota to be exceeded.</p>
192
433
  * @public
@@ -204,6 +445,46 @@ export declare class ServiceQuotaExceededException extends __BaseException {
204
445
  export declare class ValidationException extends __BaseException {
205
446
  readonly name: "ValidationException";
206
447
  readonly $fault: "client";
448
+ /**
449
+ * <p/>
450
+ * @public
451
+ */
452
+ accessControlAllowOrigin?: string | undefined;
453
+ /**
454
+ * <p/>
455
+ * @public
456
+ */
457
+ accessControlExposeHeaders?: string | undefined;
458
+ /**
459
+ * <p/>
460
+ * @public
461
+ */
462
+ cacheControl?: string | undefined;
463
+ /**
464
+ * <p/>
465
+ * @public
466
+ */
467
+ contentSecurityPolicy?: string | undefined;
468
+ /**
469
+ * <p/>
470
+ * @public
471
+ */
472
+ strictTransportSecurity?: string | undefined;
473
+ /**
474
+ * <p/>
475
+ * @public
476
+ */
477
+ xContentTypeOptions?: string | undefined;
478
+ /**
479
+ * <p/>
480
+ * @public
481
+ */
482
+ xFrameOptions?: string | undefined;
483
+ /**
484
+ * <p/>
485
+ * @public
486
+ */
487
+ xAmznErrorType?: string | undefined;
207
488
  /**
208
489
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
209
490
  * @public
@@ -322,29 +603,37 @@ export interface IngestConfiguration {
322
603
  */
323
604
  participantId: string | undefined;
324
605
  /**
325
- * <p>State of the ingest configuration. It is <code>ACTIVE</code> if a publisher currently is publishing to the stage associated with the ingest configuration.</p>
606
+ * <p>State of the ingest configuration. It is <code>ACTIVE</code> if a publisher currently is
607
+ * publishing to the stage associated with the ingest configuration.</p>
326
608
  * @public
327
609
  */
328
610
  state: IngestConfigurationState | undefined;
329
611
  /**
330
- * <p>Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
331
- * <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
612
+ * <p>Customer-assigned name to help identify the participant using the IngestConfiguration;
613
+ * this can be used to link a participant to a user in the customer’s own systems. This can be
614
+ * any UTF-8 encoded text. <i>This field is exposed to all stage participants and
615
+ * should not be used for personally identifying, confidential, or sensitive
616
+ * information.</i>
332
617
  * </p>
333
618
  * @public
334
619
  */
335
620
  userId?: string | undefined;
336
621
  /**
337
- * <p>Application-provided attributes to to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
338
- * <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
622
+ * <p>Application-provided attributes to to store in the IngestConfiguration and attach to a
623
+ * stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field
624
+ * is 1 KB total. <i>This field is exposed to all stage participants and should not be
625
+ * used for personally identifying, confidential, or sensitive
626
+ * information.</i>
339
627
  * </p>
340
628
  * @public
341
629
  */
342
630
  attributes?: Record<string, string> | undefined;
343
631
  /**
344
632
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
345
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
346
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
347
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
633
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag
634
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
635
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
636
+ * there.</p>
348
637
  * @public
349
638
  */
350
639
  tags?: Record<string, string> | undefined;
@@ -412,8 +701,9 @@ export interface CreateParticipantTokenRequest {
412
701
  /**
413
702
  * <p>Object specifying a participant token in a stage.</p>
414
703
  * <p>
415
- * <b>Important</b>: Treat tokens as opaque; i.e., do not build functionality
416
- * based on token contents. The format of tokens could change in the future.</p>
704
+ * <b>Important</b>: Treat tokens as opaque; i.e., do not build
705
+ * functionality based on token contents. The format of tokens could change in the
706
+ * future.</p>
417
707
  * @public
418
708
  */
419
709
  export interface ParticipantToken {
@@ -509,7 +799,8 @@ export declare const ThumbnailStorageType: {
509
799
  */
510
800
  export type ThumbnailStorageType = (typeof ThumbnailStorageType)[keyof typeof ThumbnailStorageType];
511
801
  /**
512
- * <p>An object representing a configuration of thumbnails for recorded video from an individual participant.</p>
802
+ * <p>An object representing a configuration of thumbnails for recorded video from an
803
+ * individual participant.</p>
513
804
  * @public
514
805
  */
515
806
  export interface ParticipantThumbnailConfiguration {
@@ -520,11 +811,12 @@ export interface ParticipantThumbnailConfiguration {
520
811
  */
521
812
  targetIntervalSeconds?: number | undefined;
522
813
  /**
523
- * <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records all generated thumbnails
524
- * in a serial manner, to the media/thumbnails/high directory. <code>LATEST</code> saves the latest thumbnail
525
- * in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by
526
- * <code>targetIntervalSeconds</code>. You can enable both <code>SEQUENTIAL</code> and <code>LATEST</code>.
527
- * Default: <code>SEQUENTIAL</code>.</p>
814
+ * <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records
815
+ * all generated thumbnails in a serial manner, to the media/thumbnails/high directory.
816
+ * <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg
817
+ * and overwrites it at the interval specified by <code>targetIntervalSeconds</code>. You can
818
+ * enable both <code>SEQUENTIAL</code> and <code>LATEST</code>. Default:
819
+ * <code>SEQUENTIAL</code>.</p>
528
820
  * @public
529
821
  */
530
822
  storage?: ThumbnailStorageType[] | undefined;
@@ -540,7 +832,12 @@ export interface ParticipantThumbnailConfiguration {
540
832
  */
541
833
  export interface AutoParticipantRecordingConfiguration {
542
834
  /**
543
- * <p>ARN of the <a>StorageConfiguration</a> resource to use for individual participant recording. Default: <code>""</code> (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a <a>Stage</a> is created or updated.</p>
835
+ * <p>ARN of the <a>StorageConfiguration</a> resource to use for individual
836
+ * participant recording. Default: <code>""</code> (empty string, no storage configuration is
837
+ * specified). Individual participant recording cannot be started unless a storage
838
+ * configuration is specified, when a <a>Stage</a> is created or updated. To
839
+ * disable individual participant recording, set this to <code>""</code>; other fields in this object will
840
+ * get reset to their defaults when sending <code>""</code>. </p>
544
841
  * @public
545
842
  */
546
843
  storageConfigurationArn: string | undefined;
@@ -550,11 +847,19 @@ export interface AutoParticipantRecordingConfiguration {
550
847
  */
551
848
  mediaTypes?: ParticipantRecordingMediaType[] | undefined;
552
849
  /**
553
- * <p>A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording
554
- * and modify the interval at which thumbnails are generated for the live session.</p>
850
+ * <p>A complex type that allows you to enable/disable the recording of thumbnails for
851
+ * individual participant recording and modify the interval at which thumbnails are generated
852
+ * for the live session.</p>
555
853
  * @public
556
854
  */
557
855
  thumbnailConfiguration?: ParticipantThumbnailConfiguration | undefined;
856
+ /**
857
+ * <p>If a stage publisher disconnects and then reconnects within the specified interval,
858
+ * the multiple recordings will be considered a single recording and merged together.</p>
859
+ * <p>The default value is 0, which disables merging.</p>
860
+ * @public
861
+ */
862
+ recordingReconnectWindowSeconds?: number | undefined;
558
863
  }
559
864
  /**
560
865
  * <p>Object specifying a participant token configuration in a stage.</p>
@@ -622,8 +927,8 @@ export interface CreateStageRequest {
622
927
  autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration | undefined;
623
928
  }
624
929
  /**
625
- * <p>Summary information about various endpoints for a stage. We recommend that you cache these values at stage
626
- * creation; the values can be cached for up to 14 days.</p>
930
+ * <p>Summary information about various endpoints for a stage. We recommend that you cache
931
+ * these values at stage creation; the values can be cached for up to 14 days.</p>
627
932
  * @public
628
933
  */
629
934
  export interface StageEndpoints {
@@ -670,9 +975,10 @@ export interface Stage {
670
975
  activeSessionId?: string | undefined;
671
976
  /**
672
977
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
673
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
674
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
675
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
978
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag
979
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
980
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
981
+ * there.</p>
676
982
  * @public
677
983
  */
678
984
  tags?: Record<string, string> | undefined;
@@ -704,13 +1010,14 @@ export interface CreateStageResponse {
704
1010
  participantTokens?: ParticipantToken[] | undefined;
705
1011
  }
706
1012
  /**
707
- * <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
1013
+ * <p>A complex type that describes an S3 location where recorded videos will be
1014
+ * stored.</p>
708
1015
  * @public
709
1016
  */
710
1017
  export interface S3StorageConfiguration {
711
1018
  /**
712
- * <p>Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration
713
- * and S3 bucket must be in the same region as the Composition.</p>
1019
+ * <p>Location (S3 bucket name) where recorded videos will be stored. Note that the
1020
+ * StorageConfiguration and S3 bucket must be in the same region as the Composition.</p>
714
1021
  * @public
715
1022
  */
716
1023
  bucketName: string | undefined;
@@ -761,9 +1068,10 @@ export interface StorageConfiguration {
761
1068
  s3?: S3StorageConfiguration | undefined;
762
1069
  /**
763
1070
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
764
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
765
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
766
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
1071
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag
1072
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
1073
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1074
+ * there.</p>
767
1075
  * @public
768
1076
  */
769
1077
  tags?: Record<string, string> | undefined;
@@ -946,42 +1254,46 @@ export interface CompositionThumbnailConfiguration {
946
1254
  */
947
1255
  targetIntervalSeconds?: number | undefined;
948
1256
  /**
949
- * <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records all generated thumbnails
950
- * in a serial manner, to the media/thumbnails/(width)x(height) directory, where (width) and (height) are the width
951
- * and height of the thumbnail. <code>LATEST</code> saves the latest thumbnail in
952
- * media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval specified by
953
- * <code>targetIntervalSeconds</code>. You can enable both <code>SEQUENTIAL</code> and <code>LATEST</code>.
954
- * Default: <code>SEQUENTIAL</code>.</p>
1257
+ * <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records
1258
+ * all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height)
1259
+ * directory, where (width) and (height) are the width and height of the thumbnail.
1260
+ * <code>LATEST</code> saves the latest thumbnail in
1261
+ * media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval
1262
+ * specified by <code>targetIntervalSeconds</code>. You can enable both
1263
+ * <code>SEQUENTIAL</code> and <code>LATEST</code>. Default:
1264
+ * <code>SEQUENTIAL</code>.</p>
955
1265
  * @public
956
1266
  */
957
1267
  storage?: ThumbnailStorageType[] | undefined;
958
1268
  }
959
1269
  /**
960
- * <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
1270
+ * <p>A complex type that describes an S3 location where recorded videos will be
1271
+ * stored.</p>
961
1272
  * @public
962
1273
  */
963
1274
  export interface S3DestinationConfiguration {
964
1275
  /**
965
- * <p>ARN of the <a>StorageConfiguration</a> where recorded videos will be stored.</p>
1276
+ * <p>ARN of the <a>StorageConfiguration</a> where recorded videos will be
1277
+ * stored.</p>
966
1278
  * @public
967
1279
  */
968
1280
  storageConfigurationArn: string | undefined;
969
1281
  /**
970
- * <p>ARNs of the <a>EncoderConfiguration</a> resource. The encoder configuration and stage resources
971
- * must be in the same AWS account and region. </p>
1282
+ * <p>ARNs of the <a>EncoderConfiguration</a> resource. The encoder configuration
1283
+ * and stage resources must be in the same AWS account and region. </p>
972
1284
  * @public
973
1285
  */
974
1286
  encoderConfigurationArns: string[] | undefined;
975
1287
  /**
976
- * <p>Array of maps, each of the form <code>string:string (key:value)</code>.
977
- * This is an optional customer specification, currently used only to specify
978
- * the recording format for storing a recording in Amazon S3.</p>
1288
+ * <p>Array of maps, each of the form <code>string:string (key:value)</code>. This is an
1289
+ * optional customer specification, currently used only to specify the recording format for
1290
+ * storing a recording in Amazon S3.</p>
979
1291
  * @public
980
1292
  */
981
1293
  recordingConfiguration?: RecordingConfiguration | undefined;
982
1294
  /**
983
- * <p>A complex type that allows you to enable/disable the recording of thumbnails for a <a>Composition</a>
984
- * and modify the interval at which thumbnails are generated for the live session.</p>
1295
+ * <p>A complex type that allows you to enable/disable the recording of thumbnails for a <a>Composition</a> and modify the interval at which thumbnails are generated for
1296
+ * the live session.</p>
985
1297
  * @public
986
1298
  */
987
1299
  thumbnailConfigurations?: CompositionThumbnailConfiguration[] | undefined;
@@ -997,14 +1309,14 @@ export interface DestinationConfiguration {
997
1309
  */
998
1310
  name?: string | undefined;
999
1311
  /**
1000
- * <p>An IVS channel to be used for broadcasting, for server-side composition. Either a <code>channel</code> or an
1001
- * <code>s3</code> must be specified. </p>
1312
+ * <p>An IVS channel to be used for broadcasting, for server-side composition. Either a
1313
+ * <code>channel</code> or an <code>s3</code> must be specified. </p>
1002
1314
  * @public
1003
1315
  */
1004
1316
  channel?: ChannelDestinationConfiguration | undefined;
1005
1317
  /**
1006
- * <p>An S3 storage configuration to be used for recording video data. Either a <code>channel</code>
1007
- * or an <code>s3</code> must be specified.</p>
1318
+ * <p>An S3 storage configuration to be used for recording video data. Either a
1319
+ * <code>channel</code> or an <code>s3</code> must be specified.</p>
1008
1320
  * @public
1009
1321
  */
1010
1322
  s3?: S3DestinationConfiguration | undefined;
@@ -1121,31 +1433,35 @@ export type VideoFillMode = (typeof VideoFillMode)[keyof typeof VideoFillMode];
1121
1433
  export interface GridConfiguration {
1122
1434
  /**
1123
1435
  * <p>This attribute name identifies the featured slot. A participant with this attribute set
1124
- * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured
1125
- * slot. Default: <code>""</code> (no featured participant).</p>
1436
+ * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured slot. Default: <code>""</code> (no featured
1437
+ * participant).</p>
1126
1438
  * @public
1127
1439
  */
1128
1440
  featuredParticipantAttribute?: string | undefined;
1129
1441
  /**
1130
- * <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
1442
+ * <p>Determines whether to omit participants with stopped video in the composition. Default:
1443
+ * <code>false</code>.</p>
1131
1444
  * @public
1132
1445
  */
1133
1446
  omitStoppedVideo?: boolean | undefined;
1134
1447
  /**
1135
- * <p>Sets the non-featured participant display mode, to control the aspect ratio of video tiles. <code>VIDEO</code> is 16:9, <code>SQUARE</code> is 1:1, and <code>PORTRAIT</code> is 3:4. Default: <code>VIDEO</code>.</p>
1448
+ * <p>Sets the non-featured participant display mode, to control the aspect ratio of video
1449
+ * tiles. <code>VIDEO</code> is 16:9, <code>SQUARE</code> is 1:1, and <code>PORTRAIT</code> is
1450
+ * 3:4. Default: <code>VIDEO</code>.</p>
1136
1451
  * @public
1137
1452
  */
1138
1453
  videoAspectRatio?: VideoAspectRatio | undefined;
1139
1454
  /**
1140
- * <p>Defines how video content fits within the participant tile: <code>FILL</code> (stretched), <code>COVER</code> (cropped),
1141
- * or <code>CONTAIN</code> (letterboxed). When not set,
1142
- * <code>videoFillMode</code> defaults to <code>COVER</code> fill mode for participants in the grid
1143
- * and to <code>CONTAIN</code> fill mode for featured participants.</p>
1455
+ * <p>Defines how video content fits within the participant tile: <code>FILL</code>
1456
+ * (stretched), <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). When not
1457
+ * set, <code>videoFillMode</code> defaults to <code>COVER</code> fill mode for participants
1458
+ * in the grid and to <code>CONTAIN</code> fill mode for featured participants.</p>
1144
1459
  * @public
1145
1460
  */
1146
1461
  videoFillMode?: VideoFillMode | undefined;
1147
1462
  /**
1148
- * <p>Specifies the spacing between participant tiles in pixels. Default: <code>2</code>.</p>
1463
+ * <p>Specifies the spacing between participant tiles in pixels. Default:
1464
+ * <code>2</code>.</p>
1149
1465
  * @public
1150
1466
  */
1151
1467
  gridGap?: number | undefined;
@@ -1177,69 +1493,72 @@ export declare const PipPosition: {
1177
1493
  */
1178
1494
  export type PipPosition = (typeof PipPosition)[keyof typeof PipPosition];
1179
1495
  /**
1180
- * <p>Configuration information specific to Picture-in-Picture (PiP) layout,
1181
- * for <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html">server-side composition</a>.
1182
- * </p>
1496
+ * <p>Configuration information specific to Picture-in-Picture (PiP) layout, for <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html">server-side composition</a>. </p>
1183
1497
  * @public
1184
1498
  */
1185
1499
  export interface PipConfiguration {
1186
1500
  /**
1187
1501
  * <p>This attribute name identifies the featured slot. A participant with this attribute set
1188
- * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured
1189
- * slot. Default: <code>""</code> (no featured participant).</p>
1502
+ * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured slot. Default: <code>""</code> (no featured
1503
+ * participant).</p>
1190
1504
  * @public
1191
1505
  */
1192
1506
  featuredParticipantAttribute?: string | undefined;
1193
1507
  /**
1194
- * <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
1508
+ * <p>Determines whether to omit participants with stopped video in the composition. Default:
1509
+ * <code>false</code>.</p>
1195
1510
  * @public
1196
1511
  */
1197
1512
  omitStoppedVideo?: boolean | undefined;
1198
1513
  /**
1199
- * <p>Defines how video content fits within the participant tile: <code>FILL</code> (stretched),
1200
- * <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). Default: <code>COVER</code>.</p>
1514
+ * <p>Defines how video content fits within the participant tile: <code>FILL</code>
1515
+ * (stretched), <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). Default:
1516
+ * <code>COVER</code>.</p>
1201
1517
  * @public
1202
1518
  */
1203
1519
  videoFillMode?: VideoFillMode | undefined;
1204
1520
  /**
1205
- * <p>Specifies the spacing between participant tiles in pixels. Default: <code>0</code>.</p>
1521
+ * <p>Specifies the spacing between participant tiles in pixels. Default:
1522
+ * <code>0</code>.</p>
1206
1523
  * @public
1207
1524
  */
1208
1525
  gridGap?: number | undefined;
1209
1526
  /**
1210
- * <p>Specifies the participant for the PiP window. A participant with this attribute set
1211
- * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a>
1212
- * is placed in the PiP slot. Default: <code>""</code> (no PiP participant).</p>
1527
+ * <p>Specifies the participant for the PiP window. A participant with this attribute set to
1528
+ * <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the PiP slot. Default: <code>""</code> (no PiP participant).</p>
1213
1529
  * @public
1214
1530
  */
1215
1531
  pipParticipantAttribute?: string | undefined;
1216
1532
  /**
1217
- * <p>Defines PiP behavior when all participants have left: <code>STATIC</code> (maintains original position/size) or <code>DYNAMIC</code> (expands to full composition). Default: <code>STATIC</code>.</p>
1533
+ * <p>Defines PiP behavior when all participants have left: <code>STATIC</code> (maintains
1534
+ * original position/size) or <code>DYNAMIC</code> (expands to full composition). Default:
1535
+ * <code>STATIC</code>.</p>
1218
1536
  * @public
1219
1537
  */
1220
1538
  pipBehavior?: PipBehavior | undefined;
1221
1539
  /**
1222
- * <p>Sets the PiP window’s offset position in pixels from the closest edges determined by <code>PipPosition</code>.
1223
- * Default: <code>0</code>.</p>
1540
+ * <p>Sets the PiP window’s offset position in pixels from the closest edges determined by
1541
+ * <code>PipPosition</code>. Default: <code>0</code>.</p>
1224
1542
  * @public
1225
1543
  */
1226
1544
  pipOffset?: number | undefined;
1227
1545
  /**
1228
- * <p>Determines the corner position of the PiP window. Default: <code>BOTTOM_RIGHT</code>.</p>
1546
+ * <p>Determines the corner position of the PiP window. Default:
1547
+ * <code>BOTTOM_RIGHT</code>.</p>
1229
1548
  * @public
1230
1549
  */
1231
1550
  pipPosition?: PipPosition | undefined;
1232
1551
  /**
1233
1552
  * <p>Specifies the width of the PiP window in pixels. When this is not set explicitly,
1234
- * <code>pipWidth</code>’s value will be based on the size of the composition and the
1235
- * aspect ratio of the participant’s video.</p>
1553
+ * <code>pipWidth</code>’s value will be based on the size of the composition and the
1554
+ * aspect ratio of the participant’s video.</p>
1236
1555
  * @public
1237
1556
  */
1238
1557
  pipWidth?: number | undefined;
1239
1558
  /**
1240
1559
  * <p>Specifies the height of the PiP window in pixels. When this is not set explicitly,
1241
- * <code>pipHeight</code>’s value will be based on the size of the composition and the
1242
- * aspect ratio of the participant’s video.</p>
1560
+ * <code>pipHeight</code>’s value will be based on the size of the composition and the
1561
+ * aspect ratio of the participant’s video.</p>
1243
1562
  * @public
1244
1563
  */
1245
1564
  pipHeight?: number | undefined;
@@ -1302,27 +1621,29 @@ export interface Composition {
1302
1621
  layout: LayoutConfiguration | undefined;
1303
1622
  /**
1304
1623
  * <p>Array of Destination objects. A Composition can contain either one destination
1305
- * (<code>channel</code> or <code>s3</code>) or two (one <code>channel</code> and one <code>s3</code>).</p>
1624
+ * (<code>channel</code> or <code>s3</code>) or two (one <code>channel</code> and one
1625
+ * <code>s3</code>).</p>
1306
1626
  * @public
1307
1627
  */
1308
1628
  destinations: Destination[] | undefined;
1309
1629
  /**
1310
1630
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1311
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
1312
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
1313
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
1631
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag
1632
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
1633
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1634
+ * there.</p>
1314
1635
  * @public
1315
1636
  */
1316
1637
  tags?: Record<string, string> | undefined;
1317
1638
  /**
1318
1639
  * <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
1319
- * this is returned as a string</i>.</p>
1640
+ * this is returned as a string</i>.</p>
1320
1641
  * @public
1321
1642
  */
1322
1643
  startTime?: Date | undefined;
1323
1644
  /**
1324
- * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that
1325
- * this is returned as a string</i>.</p>
1645
+ * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that this
1646
+ * is returned as a string</i>.</p>
1326
1647
  * @public
1327
1648
  */
1328
1649
  endTime?: Date | undefined;
@@ -1512,12 +1833,20 @@ export interface Participant {
1512
1833
  */
1513
1834
  sdkVersion?: string | undefined;
1514
1835
  /**
1515
- * <p>Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled.</p>
1836
+ * <p>Name of the S3 bucket to where the participant is being recorded, if individual
1837
+ * participant recording is enabled, or <code>""</code> (empty string), if recording is not
1838
+ * enabled.</p>
1516
1839
  * @public
1517
1840
  */
1518
1841
  recordingS3BucketName?: string | undefined;
1519
1842
  /**
1520
- * <p>S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled.</p>
1843
+ * <p>S3 prefix of the S3 bucket where the participant is being recorded, if individual
1844
+ * participant recording is enabled, or <code>""</code> (empty string), if recording is not
1845
+ * enabled. If individual participant recording merge is enabled, and if a stage publisher
1846
+ * disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as
1847
+ * the previous session. See
1848
+ * <a href="/ivs/latest/RealTimeUserGuide/rt-individual-participant-recording.html#ind-part-rec-merge-frag">
1849
+ * Merge Fragmented Individual Participant Recordings</a>.</p>
1521
1850
  * @public
1522
1851
  */
1523
1852
  recordingS3Prefix?: string | undefined;
@@ -1573,15 +1902,17 @@ export interface PublicKey {
1573
1902
  */
1574
1903
  publicKeyMaterial?: string | undefined;
1575
1904
  /**
1576
- * <p>The public key fingerprint, a short string used to identify or verify the full public key.</p>
1905
+ * <p>The public key fingerprint, a short string used to identify or verify the full public
1906
+ * key.</p>
1577
1907
  * @public
1578
1908
  */
1579
1909
  fingerprint?: string | undefined;
1580
1910
  /**
1581
1911
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1582
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
1583
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
1584
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
1912
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag
1913
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
1914
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1915
+ * there.</p>
1585
1916
  * @public
1586
1917
  */
1587
1918
  tags?: Record<string, string> | undefined;
@@ -1802,21 +2133,22 @@ export interface CompositionSummary {
1802
2133
  state: CompositionState | undefined;
1803
2134
  /**
1804
2135
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1805
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
1806
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
1807
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
2136
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag
2137
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2138
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2139
+ * there.</p>
1808
2140
  * @public
1809
2141
  */
1810
2142
  tags?: Record<string, string> | undefined;
1811
2143
  /**
1812
2144
  * <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
1813
- * this is returned as a string</i>.</p>
2145
+ * this is returned as a string</i>.</p>
1814
2146
  * @public
1815
2147
  */
1816
2148
  startTime?: Date | undefined;
1817
2149
  /**
1818
- * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that
1819
- * this is returned as a string</i>.</p>
2150
+ * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that this
2151
+ * is returned as a string</i>.</p>
1820
2152
  * @public
1821
2153
  */
1822
2154
  endTime?: Date | undefined;
@@ -1870,9 +2202,10 @@ export interface EncoderConfigurationSummary {
1870
2202
  name?: string | undefined;
1871
2203
  /**
1872
2204
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1873
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
1874
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
1875
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
2205
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag
2206
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2207
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2208
+ * there.</p>
1876
2209
  * @public
1877
2210
  */
1878
2211
  tags?: Record<string, string> | undefined;
@@ -1949,13 +2282,17 @@ export interface IngestConfigurationSummary {
1949
2282
  */
1950
2283
  participantId: string | undefined;
1951
2284
  /**
1952
- * <p>State of the ingest configuration. It is <code>ACTIVE</code> if a publisher currently is publishing to the stage associated with the ingest configuration.</p>
2285
+ * <p>State of the ingest configuration. It is <code>ACTIVE</code> if a publisher currently is
2286
+ * publishing to the stage associated with the ingest configuration.</p>
1953
2287
  * @public
1954
2288
  */
1955
2289
  state: IngestConfigurationState | undefined;
1956
2290
  /**
1957
- * <p>Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
1958
- * <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
2291
+ * <p>Customer-assigned name to help identify the participant using the IngestConfiguration;
2292
+ * this can be used to link a participant to a user in the customer’s own systems. This can be
2293
+ * any UTF-8 encoded text. <i>This field is exposed to all stage participants and
2294
+ * should not be used for personally identifying, confidential, or sensitive
2295
+ * information.</i>
1959
2296
  * </p>
1960
2297
  * @public
1961
2298
  */
@@ -2079,97 +2416,89 @@ export interface Event {
2079
2416
  remoteParticipantId?: string | undefined;
2080
2417
  /**
2081
2418
  * <p>If the event is an error event, the error code is provided to give insight into the
2082
- * specific error that occurred. If the event is not an error event, this field is null.</p>
2419
+ * specific error that occurred. If the event is not an error event, this field is
2420
+ * null.</p>
2083
2421
  * <ul>
2084
2422
  * <li>
2085
2423
  * <p>
2086
- * <code>B_FRAME_PRESENT</code> —
2087
- * The participant's stream includes B-frames.
2088
- * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html">
2089
- * IVS RTMP Publishing</a>.</p>
2424
+ * <code>B_FRAME_PRESENT</code> — The participant's stream includes B-frames.
2425
+ * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP
2426
+ * Publishing</a>.</p>
2090
2427
  * </li>
2091
2428
  * <li>
2092
2429
  * <p>
2093
- * <code>BITRATE_EXCEEDED</code> —
2094
- * The participant exceeded the maximum supported bitrate.
2095
- * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">
2096
- * Service Quotas</a>.</p>
2430
+ * <code>BITRATE_EXCEEDED</code> — The participant exceeded the maximum
2431
+ * supported bitrate. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service
2432
+ * Quotas</a>.</p>
2097
2433
  * </li>
2098
2434
  * <li>
2099
2435
  * <p>
2100
- * <code>INSUFFICIENT_CAPABILITIES</code> —
2101
- * The participant tried to take an action
2102
- * that the participant’s token is not allowed to do. For details on participant capabilities, see
2103
- * the <code>capabilities</code> field in <a>CreateParticipantToken</a>.</p>
2436
+ * <code>INSUFFICIENT_CAPABILITIES</code> — The participant tried to take an
2437
+ * action that the participant’s token is not allowed to do. For details on participant
2438
+ * capabilities, see the <code>capabilities</code> field in <a>CreateParticipantToken</a>.</p>
2104
2439
  * </li>
2105
2440
  * <li>
2106
2441
  * <p>
2107
- * <code>INTERNAL_SERVER_EXCEPTION</code> —
2108
- * The participant failed to publish to the stage due to an internal server error.</p>
2442
+ * <code>INTERNAL_SERVER_EXCEPTION</code> — The participant failed to publish
2443
+ * to the stage due to an internal server error.</p>
2109
2444
  * </li>
2110
2445
  * <li>
2111
2446
  * <p>
2112
- * <code>INVALID_AUDIO_CODEC</code> —
2113
- * The participant is using an invalid audio codec.
2114
- * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html">
2115
- * Stream Ingest</a>.</p>
2447
+ * <code>INVALID_AUDIO_CODEC</code> — The participant is using an invalid audio
2448
+ * codec. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html"> Stream
2449
+ * Ingest</a>.</p>
2116
2450
  * </li>
2117
2451
  * <li>
2118
2452
  * <p>
2119
- * <code>INVALID_INPUT</code> —
2120
- * The participant is using an invalid input stream.</p>
2453
+ * <code>INVALID_INPUT</code> — The participant is using an invalid input
2454
+ * stream.</p>
2121
2455
  * </li>
2122
2456
  * <li>
2123
2457
  * <p>
2124
- * <code>INVALID_PROTOCOL</code> —
2125
- * The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP.
2126
- * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html">
2127
- * IVS RTMP Publishing</a>.</p>
2458
+ * <code>INVALID_PROTOCOL</code> — The participant's IngestConfiguration
2459
+ * resource is configured for RTMPS but they tried streaming with RTMP. For details, see
2460
+ * <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP
2461
+ * Publishing</a>.</p>
2128
2462
  * </li>
2129
2463
  * <li>
2130
2464
  * <p>
2131
- * <code>INVALID_STREAM_KEY</code> —
2132
- * The participant is using an invalid stream key.
2133
- * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html">
2134
- * IVS RTMP Publishing</a>.</p>
2465
+ * <code>INVALID_STREAM_KEY</code> — The participant is using an invalid stream
2466
+ * key. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP
2467
+ * Publishing</a>.</p>
2135
2468
  * </li>
2136
2469
  * <li>
2137
2470
  * <p>
2138
- * <code>INVALID_VIDEO_CODEC</code> —
2139
- * The participant is using an invalid video codec.
2140
- * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html">
2141
- * Stream Ingest</a>.</p>
2471
+ * <code>INVALID_VIDEO_CODEC</code> — The participant is using an invalid video
2472
+ * codec. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html"> Stream
2473
+ * Ingest</a>.</p>
2142
2474
  * </li>
2143
2475
  * <li>
2144
2476
  * <p>
2145
- * <code>PUBLISHER_NOT_FOUND</code> —
2146
- * The participant tried to subscribe to a publisher that doesn’t exist.</p>
2477
+ * <code>PUBLISHER_NOT_FOUND</code> — The participant tried to subscribe to a
2478
+ * publisher that doesn’t exist.</p>
2147
2479
  * </li>
2148
2480
  * <li>
2149
2481
  * <p>
2150
- * <code>QUOTA_EXCEEDED</code> —
2151
- * The number of participants who want to publish/subscribe to a stage exceeds the quota.
2152
- * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">
2153
- * Service Quotas</a>.</p>
2482
+ * <code>QUOTA_EXCEEDED</code> — The number of participants who want to
2483
+ * publish/subscribe to a stage exceeds the quota. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">
2484
+ * Service Quotas</a>.</p>
2154
2485
  * </li>
2155
2486
  * <li>
2156
2487
  * <p>
2157
- * <code>RESOLUTION_EXCEEDED</code> —
2158
- * The participant exceeded the maximum supported resolution.
2159
- * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">
2160
- * Service Quotas</a>.</p>
2488
+ * <code>RESOLUTION_EXCEEDED</code> — The participant exceeded the maximum
2489
+ * supported resolution. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service
2490
+ * Quotas</a>.</p>
2161
2491
  * </li>
2162
2492
  * <li>
2163
2493
  * <p>
2164
- * <code>REUSE_OF_STREAM_KEY</code> —
2165
- * The participant tried to use a stream key that is associated with another active stage session.</p>
2494
+ * <code>REUSE_OF_STREAM_KEY</code> — The participant tried to use a stream key
2495
+ * that is associated with another active stage session.</p>
2166
2496
  * </li>
2167
2497
  * <li>
2168
2498
  * <p>
2169
- * <code>STREAM_DURATION_EXCEEDED</code> —
2170
- * The participant exceeded the maximum allowed stream duration.
2171
- * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">
2172
- * Service Quotas</a>.</p>
2499
+ * <code>STREAM_DURATION_EXCEEDED</code> — The participant exceeded the maximum
2500
+ * allowed stream duration. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service
2501
+ * Quotas</a>.</p>
2173
2502
  * </li>
2174
2503
  * </ul>
2175
2504
  * @public
@@ -2352,9 +2681,10 @@ export interface PublicKeySummary {
2352
2681
  name?: string | undefined;
2353
2682
  /**
2354
2683
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
2355
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
2356
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
2357
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
2684
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag
2685
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2686
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2687
+ * there.</p>
2358
2688
  * @public
2359
2689
  */
2360
2690
  tags?: Record<string, string> | undefined;
@@ -2412,9 +2742,10 @@ export interface StageSummary {
2412
2742
  activeSessionId?: string | undefined;
2413
2743
  /**
2414
2744
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
2415
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
2416
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
2417
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
2745
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag
2746
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2747
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2748
+ * there.</p>
2418
2749
  * @public
2419
2750
  */
2420
2751
  tags?: Record<string, string> | undefined;
@@ -2533,9 +2864,10 @@ export interface StorageConfigurationSummary {
2533
2864
  s3?: S3StorageConfiguration | undefined;
2534
2865
  /**
2535
2866
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
2536
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
2537
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
2538
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
2867
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag
2868
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2869
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2870
+ * there.</p>
2539
2871
  * @public
2540
2872
  */
2541
2873
  tags?: Record<string, string> | undefined;
@@ -2670,8 +3002,8 @@ export interface UntagResourceRequest {
2670
3002
  */
2671
3003
  resourceArn: string | undefined;
2672
3004
  /**
2673
- * <p>Array of tags to be removed. Array of maps, each of the form <code>string:string
2674
- * (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
3005
+ * <p>Array of tag keys (strings) for the tags to be removed.
3006
+ * See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
2675
3007
  * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
2676
3008
  * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2677
3009
  * there.</p>