@aws-sdk/client-ivs-realtime 3.758.0 → 3.767.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.
@@ -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 {
@@ -471,6 +761,19 @@ export interface CreateParticipantTokenResponse {
471
761
  */
472
762
  participantToken?: ParticipantToken | undefined;
473
763
  }
764
+ /**
765
+ * <p>An object representing a configuration of participant HLS recordings for individual participant recording.</p>
766
+ * @public
767
+ */
768
+ export interface ParticipantRecordingHlsConfiguration {
769
+ /**
770
+ * <p>Defines the target duration for recorded segments generated when recording a stage participant.
771
+ * Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe.
772
+ * Default: 6.</p>
773
+ * @public
774
+ */
775
+ targetSegmentDurationSeconds?: number | undefined;
776
+ }
474
777
  /**
475
778
  * @public
476
779
  * @enum
@@ -509,7 +812,8 @@ export declare const ThumbnailStorageType: {
509
812
  */
510
813
  export type ThumbnailStorageType = (typeof ThumbnailStorageType)[keyof typeof ThumbnailStorageType];
511
814
  /**
512
- * <p>An object representing a configuration of thumbnails for recorded video from an individual participant.</p>
815
+ * <p>An object representing a configuration of thumbnails for recorded video from an
816
+ * individual participant.</p>
513
817
  * @public
514
818
  */
515
819
  export interface ParticipantThumbnailConfiguration {
@@ -520,11 +824,12 @@ export interface ParticipantThumbnailConfiguration {
520
824
  */
521
825
  targetIntervalSeconds?: number | undefined;
522
826
  /**
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>
827
+ * <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records
828
+ * all generated thumbnails in a serial manner, to the media/thumbnails/high directory.
829
+ * <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg
830
+ * and overwrites it at the interval specified by <code>targetIntervalSeconds</code>. You can
831
+ * enable both <code>SEQUENTIAL</code> and <code>LATEST</code>. Default:
832
+ * <code>SEQUENTIAL</code>.</p>
528
833
  * @public
529
834
  */
530
835
  storage?: ThumbnailStorageType[] | undefined;
@@ -540,7 +845,12 @@ export interface ParticipantThumbnailConfiguration {
540
845
  */
541
846
  export interface AutoParticipantRecordingConfiguration {
542
847
  /**
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>
848
+ * <p>ARN of the <a>StorageConfiguration</a> resource to use for individual
849
+ * participant recording. Default: <code>""</code> (empty string, no storage configuration is
850
+ * specified). Individual participant recording cannot be started unless a storage
851
+ * configuration is specified, when a <a>Stage</a> is created or updated. To
852
+ * disable individual participant recording, set this to <code>""</code>; other fields in this object will
853
+ * get reset to their defaults when sending <code>""</code>. </p>
544
854
  * @public
545
855
  */
546
856
  storageConfigurationArn: string | undefined;
@@ -550,11 +860,24 @@ export interface AutoParticipantRecordingConfiguration {
550
860
  */
551
861
  mediaTypes?: ParticipantRecordingMediaType[] | undefined;
552
862
  /**
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>
863
+ * <p>A complex type that allows you to enable/disable the recording of thumbnails for
864
+ * individual participant recording and modify the interval at which thumbnails are generated
865
+ * for the live session.</p>
555
866
  * @public
556
867
  */
557
868
  thumbnailConfiguration?: ParticipantThumbnailConfiguration | undefined;
869
+ /**
870
+ * <p>If a stage publisher disconnects and then reconnects within the specified interval,
871
+ * the multiple recordings will be considered a single recording and merged together.</p>
872
+ * <p>The default value is 0, which disables merging.</p>
873
+ * @public
874
+ */
875
+ recordingReconnectWindowSeconds?: number | undefined;
876
+ /**
877
+ * <p>HLS configuration object for individual participant recording.</p>
878
+ * @public
879
+ */
880
+ hlsConfiguration?: ParticipantRecordingHlsConfiguration | undefined;
558
881
  }
559
882
  /**
560
883
  * <p>Object specifying a participant token configuration in a stage.</p>
@@ -622,8 +945,8 @@ export interface CreateStageRequest {
622
945
  autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration | undefined;
623
946
  }
624
947
  /**
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>
948
+ * <p>Summary information about various endpoints for a stage. We recommend that you cache
949
+ * these values at stage creation; the values can be cached for up to 14 days.</p>
627
950
  * @public
628
951
  */
629
952
  export interface StageEndpoints {
@@ -670,9 +993,10 @@ export interface Stage {
670
993
  activeSessionId?: string | undefined;
671
994
  /**
672
995
  * <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>
996
+ * (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
997
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
998
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
999
+ * there.</p>
676
1000
  * @public
677
1001
  */
678
1002
  tags?: Record<string, string> | undefined;
@@ -704,13 +1028,14 @@ export interface CreateStageResponse {
704
1028
  participantTokens?: ParticipantToken[] | undefined;
705
1029
  }
706
1030
  /**
707
- * <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
1031
+ * <p>A complex type that describes an S3 location where recorded videos will be
1032
+ * stored.</p>
708
1033
  * @public
709
1034
  */
710
1035
  export interface S3StorageConfiguration {
711
1036
  /**
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>
1037
+ * <p>Location (S3 bucket name) where recorded videos will be stored. Note that the
1038
+ * StorageConfiguration and S3 bucket must be in the same region as the Composition.</p>
714
1039
  * @public
715
1040
  */
716
1041
  bucketName: string | undefined;
@@ -761,9 +1086,10 @@ export interface StorageConfiguration {
761
1086
  s3?: S3StorageConfiguration | undefined;
762
1087
  /**
763
1088
  * <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>
1089
+ * (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
1090
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
1091
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1092
+ * there.</p>
767
1093
  * @public
768
1094
  */
769
1095
  tags?: Record<string, string> | undefined;
@@ -924,11 +1250,29 @@ export declare const RecordingConfigurationFormat: {
924
1250
  * @public
925
1251
  */
926
1252
  export type RecordingConfigurationFormat = (typeof RecordingConfigurationFormat)[keyof typeof RecordingConfigurationFormat];
1253
+ /**
1254
+ * <p>An object representing a configuration of HLS recordings for server-side composition.</p>
1255
+ * @public
1256
+ */
1257
+ export interface CompositionRecordingHlsConfiguration {
1258
+ /**
1259
+ * <p>Defines the target duration for recorded segments generated when using composite recording.
1260
+ * Segments may have durations shorter than the specified value when needed to ensure each segment
1261
+ * begins with a keyframe. Default: 2.</p>
1262
+ * @public
1263
+ */
1264
+ targetSegmentDurationSeconds?: number | undefined;
1265
+ }
927
1266
  /**
928
1267
  * <p>An object representing a configuration to record a stage stream.</p>
929
1268
  * @public
930
1269
  */
931
1270
  export interface RecordingConfiguration {
1271
+ /**
1272
+ * <p>An HLS configuration object to return information about how the recording will be configured.</p>
1273
+ * @public
1274
+ */
1275
+ hlsConfiguration?: CompositionRecordingHlsConfiguration | undefined;
932
1276
  /**
933
1277
  * <p>The recording format for storing a recording in Amazon S3.</p>
934
1278
  * @public
@@ -946,42 +1290,46 @@ export interface CompositionThumbnailConfiguration {
946
1290
  */
947
1291
  targetIntervalSeconds?: number | undefined;
948
1292
  /**
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>
1293
+ * <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records
1294
+ * all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height)
1295
+ * directory, where (width) and (height) are the width and height of the thumbnail.
1296
+ * <code>LATEST</code> saves the latest thumbnail in
1297
+ * media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval
1298
+ * specified by <code>targetIntervalSeconds</code>. You can enable both
1299
+ * <code>SEQUENTIAL</code> and <code>LATEST</code>. Default:
1300
+ * <code>SEQUENTIAL</code>.</p>
955
1301
  * @public
956
1302
  */
957
1303
  storage?: ThumbnailStorageType[] | undefined;
958
1304
  }
959
1305
  /**
960
- * <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
1306
+ * <p>A complex type that describes an S3 location where recorded videos will be
1307
+ * stored.</p>
961
1308
  * @public
962
1309
  */
963
1310
  export interface S3DestinationConfiguration {
964
1311
  /**
965
- * <p>ARN of the <a>StorageConfiguration</a> where recorded videos will be stored.</p>
1312
+ * <p>ARN of the <a>StorageConfiguration</a> where recorded videos will be
1313
+ * stored.</p>
966
1314
  * @public
967
1315
  */
968
1316
  storageConfigurationArn: string | undefined;
969
1317
  /**
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>
1318
+ * <p>ARNs of the <a>EncoderConfiguration</a> resource. The encoder configuration
1319
+ * and stage resources must be in the same AWS account and region. </p>
972
1320
  * @public
973
1321
  */
974
1322
  encoderConfigurationArns: string[] | undefined;
975
1323
  /**
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>
1324
+ * <p>Array of maps, each of the form <code>string:string (key:value)</code>. This is an
1325
+ * optional customer specification, currently used only to specify the recording format for
1326
+ * storing a recording in Amazon S3.</p>
979
1327
  * @public
980
1328
  */
981
1329
  recordingConfiguration?: RecordingConfiguration | undefined;
982
1330
  /**
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>
1331
+ * <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
1332
+ * the live session.</p>
985
1333
  * @public
986
1334
  */
987
1335
  thumbnailConfigurations?: CompositionThumbnailConfiguration[] | undefined;
@@ -997,14 +1345,14 @@ export interface DestinationConfiguration {
997
1345
  */
998
1346
  name?: string | undefined;
999
1347
  /**
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>
1348
+ * <p>An IVS channel to be used for broadcasting, for server-side composition. Either a
1349
+ * <code>channel</code> or an <code>s3</code> must be specified. </p>
1002
1350
  * @public
1003
1351
  */
1004
1352
  channel?: ChannelDestinationConfiguration | undefined;
1005
1353
  /**
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>
1354
+ * <p>An S3 storage configuration to be used for recording video data. Either a
1355
+ * <code>channel</code> or an <code>s3</code> must be specified.</p>
1008
1356
  * @public
1009
1357
  */
1010
1358
  s3?: S3DestinationConfiguration | undefined;
@@ -1121,31 +1469,35 @@ export type VideoFillMode = (typeof VideoFillMode)[keyof typeof VideoFillMode];
1121
1469
  export interface GridConfiguration {
1122
1470
  /**
1123
1471
  * <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>
1472
+ * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured slot. Default: <code>""</code> (no featured
1473
+ * participant).</p>
1126
1474
  * @public
1127
1475
  */
1128
1476
  featuredParticipantAttribute?: string | undefined;
1129
1477
  /**
1130
- * <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
1478
+ * <p>Determines whether to omit participants with stopped video in the composition. Default:
1479
+ * <code>false</code>.</p>
1131
1480
  * @public
1132
1481
  */
1133
1482
  omitStoppedVideo?: boolean | undefined;
1134
1483
  /**
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>
1484
+ * <p>Sets the non-featured participant display mode, to control the aspect ratio of video
1485
+ * tiles. <code>VIDEO</code> is 16:9, <code>SQUARE</code> is 1:1, and <code>PORTRAIT</code> is
1486
+ * 3:4. Default: <code>VIDEO</code>.</p>
1136
1487
  * @public
1137
1488
  */
1138
1489
  videoAspectRatio?: VideoAspectRatio | undefined;
1139
1490
  /**
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>
1491
+ * <p>Defines how video content fits within the participant tile: <code>FILL</code>
1492
+ * (stretched), <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). When not
1493
+ * set, <code>videoFillMode</code> defaults to <code>COVER</code> fill mode for participants
1494
+ * in the grid and to <code>CONTAIN</code> fill mode for featured participants.</p>
1144
1495
  * @public
1145
1496
  */
1146
1497
  videoFillMode?: VideoFillMode | undefined;
1147
1498
  /**
1148
- * <p>Specifies the spacing between participant tiles in pixels. Default: <code>2</code>.</p>
1499
+ * <p>Specifies the spacing between participant tiles in pixels. Default:
1500
+ * <code>2</code>.</p>
1149
1501
  * @public
1150
1502
  */
1151
1503
  gridGap?: number | undefined;
@@ -1177,69 +1529,72 @@ export declare const PipPosition: {
1177
1529
  */
1178
1530
  export type PipPosition = (typeof PipPosition)[keyof typeof PipPosition];
1179
1531
  /**
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>
1532
+ * <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
1533
  * @public
1184
1534
  */
1185
1535
  export interface PipConfiguration {
1186
1536
  /**
1187
1537
  * <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>
1538
+ * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured slot. Default: <code>""</code> (no featured
1539
+ * participant).</p>
1190
1540
  * @public
1191
1541
  */
1192
1542
  featuredParticipantAttribute?: string | undefined;
1193
1543
  /**
1194
- * <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
1544
+ * <p>Determines whether to omit participants with stopped video in the composition. Default:
1545
+ * <code>false</code>.</p>
1195
1546
  * @public
1196
1547
  */
1197
1548
  omitStoppedVideo?: boolean | undefined;
1198
1549
  /**
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>
1550
+ * <p>Defines how video content fits within the participant tile: <code>FILL</code>
1551
+ * (stretched), <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). Default:
1552
+ * <code>COVER</code>.</p>
1201
1553
  * @public
1202
1554
  */
1203
1555
  videoFillMode?: VideoFillMode | undefined;
1204
1556
  /**
1205
- * <p>Specifies the spacing between participant tiles in pixels. Default: <code>0</code>.</p>
1557
+ * <p>Specifies the spacing between participant tiles in pixels. Default:
1558
+ * <code>0</code>.</p>
1206
1559
  * @public
1207
1560
  */
1208
1561
  gridGap?: number | undefined;
1209
1562
  /**
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>
1563
+ * <p>Specifies the participant for the PiP window. A participant with this attribute set to
1564
+ * <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
1565
  * @public
1214
1566
  */
1215
1567
  pipParticipantAttribute?: string | undefined;
1216
1568
  /**
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>
1569
+ * <p>Defines PiP behavior when all participants have left: <code>STATIC</code> (maintains
1570
+ * original position/size) or <code>DYNAMIC</code> (expands to full composition). Default:
1571
+ * <code>STATIC</code>.</p>
1218
1572
  * @public
1219
1573
  */
1220
1574
  pipBehavior?: PipBehavior | undefined;
1221
1575
  /**
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>
1576
+ * <p>Sets the PiP window’s offset position in pixels from the closest edges determined by
1577
+ * <code>PipPosition</code>. Default: <code>0</code>.</p>
1224
1578
  * @public
1225
1579
  */
1226
1580
  pipOffset?: number | undefined;
1227
1581
  /**
1228
- * <p>Determines the corner position of the PiP window. Default: <code>BOTTOM_RIGHT</code>.</p>
1582
+ * <p>Determines the corner position of the PiP window. Default:
1583
+ * <code>BOTTOM_RIGHT</code>.</p>
1229
1584
  * @public
1230
1585
  */
1231
1586
  pipPosition?: PipPosition | undefined;
1232
1587
  /**
1233
1588
  * <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>
1589
+ * <code>pipWidth</code>’s value will be based on the size of the composition and the
1590
+ * aspect ratio of the participant’s video.</p>
1236
1591
  * @public
1237
1592
  */
1238
1593
  pipWidth?: number | undefined;
1239
1594
  /**
1240
1595
  * <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>
1596
+ * <code>pipHeight</code>’s value will be based on the size of the composition and the
1597
+ * aspect ratio of the participant’s video.</p>
1243
1598
  * @public
1244
1599
  */
1245
1600
  pipHeight?: number | undefined;
@@ -1302,27 +1657,29 @@ export interface Composition {
1302
1657
  layout: LayoutConfiguration | undefined;
1303
1658
  /**
1304
1659
  * <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>
1660
+ * (<code>channel</code> or <code>s3</code>) or two (one <code>channel</code> and one
1661
+ * <code>s3</code>).</p>
1306
1662
  * @public
1307
1663
  */
1308
1664
  destinations: Destination[] | undefined;
1309
1665
  /**
1310
1666
  * <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>
1667
+ * (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
1668
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
1669
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1670
+ * there.</p>
1314
1671
  * @public
1315
1672
  */
1316
1673
  tags?: Record<string, string> | undefined;
1317
1674
  /**
1318
1675
  * <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>
1676
+ * this is returned as a string</i>.</p>
1320
1677
  * @public
1321
1678
  */
1322
1679
  startTime?: Date | undefined;
1323
1680
  /**
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>
1681
+ * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that this
1682
+ * is returned as a string</i>.</p>
1326
1683
  * @public
1327
1684
  */
1328
1685
  endTime?: Date | undefined;
@@ -1512,12 +1869,16 @@ export interface Participant {
1512
1869
  */
1513
1870
  sdkVersion?: string | undefined;
1514
1871
  /**
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>
1872
+ * <p>Name of the S3 bucket to where the participant is being recorded, if individual
1873
+ * participant recording is enabled, or <code>""</code> (empty string), if recording is not
1874
+ * enabled.</p>
1516
1875
  * @public
1517
1876
  */
1518
1877
  recordingS3BucketName?: string | undefined;
1519
1878
  /**
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>
1879
+ * <p>S3 prefix of the S3 bucket where the participant is being recorded, if individual
1880
+ * participant recording is enabled, or <code>""</code> (empty string), if recording is not
1881
+ * enabled.</p>
1521
1882
  * @public
1522
1883
  */
1523
1884
  recordingS3Prefix?: string | undefined;
@@ -1573,15 +1934,17 @@ export interface PublicKey {
1573
1934
  */
1574
1935
  publicKeyMaterial?: string | undefined;
1575
1936
  /**
1576
- * <p>The public key fingerprint, a short string used to identify or verify the full public key.</p>
1937
+ * <p>The public key fingerprint, a short string used to identify or verify the full public
1938
+ * key.</p>
1577
1939
  * @public
1578
1940
  */
1579
1941
  fingerprint?: string | undefined;
1580
1942
  /**
1581
1943
  * <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>
1944
+ * (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
1945
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
1946
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1947
+ * there.</p>
1585
1948
  * @public
1586
1949
  */
1587
1950
  tags?: Record<string, string> | undefined;
@@ -1802,21 +2165,22 @@ export interface CompositionSummary {
1802
2165
  state: CompositionState | undefined;
1803
2166
  /**
1804
2167
  * <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>
2168
+ * (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
2169
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2170
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2171
+ * there.</p>
1808
2172
  * @public
1809
2173
  */
1810
2174
  tags?: Record<string, string> | undefined;
1811
2175
  /**
1812
2176
  * <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>
2177
+ * this is returned as a string</i>.</p>
1814
2178
  * @public
1815
2179
  */
1816
2180
  startTime?: Date | undefined;
1817
2181
  /**
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>
2182
+ * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that this
2183
+ * is returned as a string</i>.</p>
1820
2184
  * @public
1821
2185
  */
1822
2186
  endTime?: Date | undefined;
@@ -1870,9 +2234,10 @@ export interface EncoderConfigurationSummary {
1870
2234
  name?: string | undefined;
1871
2235
  /**
1872
2236
  * <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>
2237
+ * (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
2238
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2239
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2240
+ * there.</p>
1876
2241
  * @public
1877
2242
  */
1878
2243
  tags?: Record<string, string> | undefined;
@@ -1949,13 +2314,17 @@ export interface IngestConfigurationSummary {
1949
2314
  */
1950
2315
  participantId: string | undefined;
1951
2316
  /**
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>
2317
+ * <p>State of the ingest configuration. It is <code>ACTIVE</code> if a publisher currently is
2318
+ * publishing to the stage associated with the ingest configuration.</p>
1953
2319
  * @public
1954
2320
  */
1955
2321
  state: IngestConfigurationState | undefined;
1956
2322
  /**
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>
2323
+ * <p>Customer-assigned name to help identify the participant using the IngestConfiguration;
2324
+ * this can be used to link a participant to a user in the customer’s own systems. This can be
2325
+ * any UTF-8 encoded text. <i>This field is exposed to all stage participants and
2326
+ * should not be used for personally identifying, confidential, or sensitive
2327
+ * information.</i>
1959
2328
  * </p>
1960
2329
  * @public
1961
2330
  */
@@ -2079,97 +2448,89 @@ export interface Event {
2079
2448
  remoteParticipantId?: string | undefined;
2080
2449
  /**
2081
2450
  * <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>
2451
+ * specific error that occurred. If the event is not an error event, this field is
2452
+ * null.</p>
2083
2453
  * <ul>
2084
2454
  * <li>
2085
2455
  * <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>
2456
+ * <code>B_FRAME_PRESENT</code> — The participant's stream includes B-frames.
2457
+ * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP
2458
+ * Publishing</a>.</p>
2090
2459
  * </li>
2091
2460
  * <li>
2092
2461
  * <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>
2462
+ * <code>BITRATE_EXCEEDED</code> — The participant exceeded the maximum
2463
+ * supported bitrate. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service
2464
+ * Quotas</a>.</p>
2097
2465
  * </li>
2098
2466
  * <li>
2099
2467
  * <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>
2468
+ * <code>INSUFFICIENT_CAPABILITIES</code> — The participant tried to take an
2469
+ * action that the participant’s token is not allowed to do. For details on participant
2470
+ * capabilities, see the <code>capabilities</code> field in <a>CreateParticipantToken</a>.</p>
2104
2471
  * </li>
2105
2472
  * <li>
2106
2473
  * <p>
2107
- * <code>INTERNAL_SERVER_EXCEPTION</code> —
2108
- * The participant failed to publish to the stage due to an internal server error.</p>
2474
+ * <code>INTERNAL_SERVER_EXCEPTION</code> — The participant failed to publish
2475
+ * to the stage due to an internal server error.</p>
2109
2476
  * </li>
2110
2477
  * <li>
2111
2478
  * <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>
2479
+ * <code>INVALID_AUDIO_CODEC</code> — The participant is using an invalid audio
2480
+ * codec. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html"> Stream
2481
+ * Ingest</a>.</p>
2116
2482
  * </li>
2117
2483
  * <li>
2118
2484
  * <p>
2119
- * <code>INVALID_INPUT</code> —
2120
- * The participant is using an invalid input stream.</p>
2485
+ * <code>INVALID_INPUT</code> — The participant is using an invalid input
2486
+ * stream.</p>
2121
2487
  * </li>
2122
2488
  * <li>
2123
2489
  * <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>
2490
+ * <code>INVALID_PROTOCOL</code> — The participant's IngestConfiguration
2491
+ * resource is configured for RTMPS but they tried streaming with RTMP. For details, see
2492
+ * <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP
2493
+ * Publishing</a>.</p>
2128
2494
  * </li>
2129
2495
  * <li>
2130
2496
  * <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>
2497
+ * <code>INVALID_STREAM_KEY</code> — The participant is using an invalid stream
2498
+ * key. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP
2499
+ * Publishing</a>.</p>
2135
2500
  * </li>
2136
2501
  * <li>
2137
2502
  * <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>
2503
+ * <code>INVALID_VIDEO_CODEC</code> — The participant is using an invalid video
2504
+ * codec. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html"> Stream
2505
+ * Ingest</a>.</p>
2142
2506
  * </li>
2143
2507
  * <li>
2144
2508
  * <p>
2145
- * <code>PUBLISHER_NOT_FOUND</code> —
2146
- * The participant tried to subscribe to a publisher that doesn’t exist.</p>
2509
+ * <code>PUBLISHER_NOT_FOUND</code> — The participant tried to subscribe to a
2510
+ * publisher that doesn’t exist.</p>
2147
2511
  * </li>
2148
2512
  * <li>
2149
2513
  * <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>
2514
+ * <code>QUOTA_EXCEEDED</code> — The number of participants who want to
2515
+ * publish/subscribe to a stage exceeds the quota. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">
2516
+ * Service Quotas</a>.</p>
2154
2517
  * </li>
2155
2518
  * <li>
2156
2519
  * <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>
2520
+ * <code>RESOLUTION_EXCEEDED</code> — The participant exceeded the maximum
2521
+ * supported resolution. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service
2522
+ * Quotas</a>.</p>
2161
2523
  * </li>
2162
2524
  * <li>
2163
2525
  * <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>
2526
+ * <code>REUSE_OF_STREAM_KEY</code> — The participant tried to use a stream key
2527
+ * that is associated with another active stage session.</p>
2166
2528
  * </li>
2167
2529
  * <li>
2168
2530
  * <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>
2531
+ * <code>STREAM_DURATION_EXCEEDED</code> — The participant exceeded the maximum
2532
+ * allowed stream duration. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service
2533
+ * Quotas</a>.</p>
2173
2534
  * </li>
2174
2535
  * </ul>
2175
2536
  * @public
@@ -2352,9 +2713,10 @@ export interface PublicKeySummary {
2352
2713
  name?: string | undefined;
2353
2714
  /**
2354
2715
  * <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>
2716
+ * (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
2717
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2718
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2719
+ * there.</p>
2358
2720
  * @public
2359
2721
  */
2360
2722
  tags?: Record<string, string> | undefined;
@@ -2412,9 +2774,10 @@ export interface StageSummary {
2412
2774
  activeSessionId?: string | undefined;
2413
2775
  /**
2414
2776
  * <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>
2777
+ * (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
2778
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2779
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2780
+ * there.</p>
2418
2781
  * @public
2419
2782
  */
2420
2783
  tags?: Record<string, string> | undefined;
@@ -2533,9 +2896,10 @@ export interface StorageConfigurationSummary {
2533
2896
  s3?: S3StorageConfiguration | undefined;
2534
2897
  /**
2535
2898
  * <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>
2899
+ * (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
2900
+ * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2901
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2902
+ * there.</p>
2539
2903
  * @public
2540
2904
  */
2541
2905
  tags?: Record<string, string> | undefined;
@@ -2670,8 +3034,8 @@ export interface UntagResourceRequest {
2670
3034
  */
2671
3035
  resourceArn: string | undefined;
2672
3036
  /**
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>
3037
+ * <p>Array of tag keys (strings) for the tags to be removed.
3038
+ * See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
2675
3039
  * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
2676
3040
  * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2677
3041
  * there.</p>