@aws-sdk/client-ivs-realtime 3.1134.0 → 3.1136.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 (49) hide show
  1. package/README.md +1 -78
  2. package/dist-cjs/index.js +5 -5
  3. package/dist-es/schemas/schemas_0.js +4 -4
  4. package/dist-types/IVSRealTime.d.ts +1 -78
  5. package/dist-types/IVSRealTimeClient.d.ts +1 -78
  6. package/dist-types/commands/CreateEncoderConfigurationCommand.d.ts +7 -7
  7. package/dist-types/commands/CreateIngestConfigurationCommand.d.ts +11 -4
  8. package/dist-types/commands/CreateParticipantTokenCommand.d.ts +6 -10
  9. package/dist-types/commands/CreateStageCommand.d.ts +4 -4
  10. package/dist-types/commands/CreateStorageConfigurationCommand.d.ts +8 -10
  11. package/dist-types/commands/DeleteEncoderConfigurationCommand.d.ts +7 -8
  12. package/dist-types/commands/DeleteIngestConfigurationCommand.d.ts +5 -5
  13. package/dist-types/commands/DeletePublicKeyCommand.d.ts +6 -8
  14. package/dist-types/commands/DeleteStageCommand.d.ts +6 -8
  15. package/dist-types/commands/DeleteStorageConfigurationCommand.d.ts +7 -10
  16. package/dist-types/commands/DisconnectParticipantCommand.d.ts +5 -7
  17. package/dist-types/commands/GetCompositionCommand.d.ts +6 -6
  18. package/dist-types/commands/GetEncoderConfigurationCommand.d.ts +6 -6
  19. package/dist-types/commands/GetIngestConfigurationCommand.d.ts +3 -3
  20. package/dist-types/commands/GetParticipantCommand.d.ts +3 -3
  21. package/dist-types/commands/GetPublicKeyCommand.d.ts +3 -3
  22. package/dist-types/commands/GetStageCommand.d.ts +3 -3
  23. package/dist-types/commands/GetStageSessionCommand.d.ts +3 -3
  24. package/dist-types/commands/GetStorageConfigurationCommand.d.ts +6 -6
  25. package/dist-types/commands/ImportPublicKeyCommand.d.ts +5 -5
  26. package/dist-types/commands/ListCompositionsCommand.d.ts +6 -7
  27. package/dist-types/commands/ListEncoderConfigurationsCommand.d.ts +6 -7
  28. package/dist-types/commands/ListIngestConfigurationsCommand.d.ts +2 -2
  29. package/dist-types/commands/ListParticipantEventsCommand.d.ts +3 -4
  30. package/dist-types/commands/ListParticipantReplicasCommand.d.ts +2 -2
  31. package/dist-types/commands/ListParticipantsCommand.d.ts +2 -2
  32. package/dist-types/commands/ListPublicKeysCommand.d.ts +2 -2
  33. package/dist-types/commands/ListStageSessionsCommand.d.ts +2 -2
  34. package/dist-types/commands/ListStagesCommand.d.ts +4 -5
  35. package/dist-types/commands/ListStorageConfigurationsCommand.d.ts +6 -7
  36. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -3
  37. package/dist-types/commands/StartCompositionCommand.d.ts +8 -31
  38. package/dist-types/commands/StartParticipantReplicationCommand.d.ts +7 -7
  39. package/dist-types/commands/StopCompositionCommand.d.ts +7 -8
  40. package/dist-types/commands/StopParticipantReplicationCommand.d.ts +4 -4
  41. package/dist-types/commands/TagResourceCommand.d.ts +3 -3
  42. package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
  43. package/dist-types/commands/UpdateIngestConfigurationCommand.d.ts +12 -5
  44. package/dist-types/commands/UpdateStageCommand.d.ts +6 -6
  45. package/dist-types/index.d.ts +1 -78
  46. package/dist-types/models/errors.d.ts +7 -7
  47. package/dist-types/models/models_0.d.ts +210 -533
  48. package/dist-types/ts3.4/models/models_0.d.ts +14 -0
  49. package/package.json +1 -1
@@ -5,16 +5,12 @@ import type { CompositionState, DestinationState, EventErrorCode, EventName, Ing
5
5
  */
6
6
  export interface Video {
7
7
  /**
8
- * <p>Video-resolution width. This must be an even number. Note that the maximum value is
9
- * determined by <code>width</code> times <code>height</code>, such that the maximum total
10
- * pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.</p>
8
+ * <p>Video-resolution width. This must be an even number. Note that the maximum value is determined by <code>width</code> times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.</p>
11
9
  * @public
12
10
  */
13
11
  width?: number | undefined;
14
12
  /**
15
- * <p>Video-resolution height. This must be an even number. Note that the maximum value is
16
- * determined by <code>width</code> times <code>height</code>, such that the maximum total
17
- * pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.</p>
13
+ * <p>Video-resolution height. This must be an even number. Note that the maximum value is determined by <code>width</code> times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.</p>
18
14
  * @public
19
15
  */
20
16
  height?: number | undefined;
@@ -39,17 +35,12 @@ export interface CreateEncoderConfigurationRequest {
39
35
  */
40
36
  name?: string | undefined;
41
37
  /**
42
- * <p>Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30
43
- * fps.</p>
38
+ * <p>Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.</p>
44
39
  * @public
45
40
  */
46
41
  video?: Video | undefined;
47
42
  /**
48
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
49
- * (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>
50
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
51
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
52
- * there.</p>
43
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
53
44
  * @public
54
45
  */
55
46
  tags?: Record<string, string> | undefined;
@@ -70,17 +61,12 @@ export interface EncoderConfiguration {
70
61
  */
71
62
  name?: string | undefined;
72
63
  /**
73
- * <p>Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30
74
- * fps</p>
64
+ * <p>Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps</p>
75
65
  * @public
76
66
  */
77
67
  video?: Video | undefined;
78
68
  /**
79
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
80
- * (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
81
- * Editor</i> for details, including restrictions that apply to tags and "Tag naming
82
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
83
- * there.</p>
69
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
84
70
  * @public
85
71
  */
86
72
  tags?: Record<string, string> | undefined;
@@ -110,16 +96,12 @@ export interface CreateIngestConfigurationRequest {
110
96
  */
111
97
  stageArn?: string | undefined;
112
98
  /**
113
- * <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.
114
- * <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
115
- * </p>
99
+ * <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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
116
100
  * @public
117
101
  */
118
102
  userId?: string | undefined;
119
103
  /**
120
- * <p>Application-provided attributes 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.
121
- * <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
122
- * </p>
104
+ * <p>Application-provided attributes 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
123
105
  * @public
124
106
  */
125
107
  attributes?: Record<string, string> | undefined;
@@ -134,16 +116,12 @@ export interface CreateIngestConfigurationRequest {
134
116
  */
135
117
  insecureIngest?: boolean | undefined;
136
118
  /**
137
- * <p>Indicates whether redundant ingest is enabled for the ingest configuration. Default: <code>false</code>.</p>
119
+ * <p>Indicates whether redundant ingest is enabled for the ingest configuration. Default: <code>false</code>. </p>
138
120
  * @public
139
121
  */
140
122
  redundantIngest?: boolean | undefined;
141
123
  /**
142
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
143
- * (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>
144
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
145
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
146
- * there.</p>
124
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
147
125
  * @public
148
126
  */
149
127
  tags?: Record<string, string> | undefined;
@@ -200,18 +178,12 @@ export interface IngestConfiguration {
200
178
  */
201
179
  participantId: string | undefined;
202
180
  /**
203
- * <p>State of the ingest configuration. It is <code>ACTIVE</code> if a publisher currently is
204
- * publishing to the stage associated with the ingest configuration.</p>
181
+ * <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>
205
182
  * @public
206
183
  */
207
184
  state: IngestConfigurationState | undefined;
208
185
  /**
209
- * <p>Customer-assigned name to help identify the participant using the IngestConfiguration;
210
- * this can be used to link a participant to a user in the customer’s own systems. This can be
211
- * any UTF-8 encoded text. <i>This field is exposed to all stage participants and
212
- * should not be used for personally identifying, confidential, or sensitive
213
- * information.</i>
214
- * </p>
186
+ * <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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
215
187
  * @public
216
188
  */
217
189
  userId?: string | undefined;
@@ -221,28 +193,17 @@ export interface IngestConfiguration {
221
193
  */
222
194
  redundantIngest?: boolean | undefined;
223
195
  /**
224
- * <p>A list of redundant ingest credentials, present only when <code>redundantIngest</code> is set to <code>true</code>.
225
- * See <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html#redundant-ingest">Redundant Ingest</a> in
226
- * <i>IVS RTMP Publishing</i> for details.</p>
196
+ * <p>A list of redundant ingest credentials, present only when <code>redundantIngest</code> is set to <code>true</code>. See <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html#redundant-ingest">Redundant Ingest</a> in <i>IVS RTMP Publishing</i> for details.</p>
227
197
  * @public
228
198
  */
229
199
  redundantIngestCredentials?: RedundantIngestCredential[] | undefined;
230
200
  /**
231
- * <p>Application-provided attributes to to store in the IngestConfiguration and attach to a
232
- * stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field
233
- * is 1 KB total. <i>This field is exposed to all stage participants and should not be
234
- * used for personally identifying, confidential, or sensitive
235
- * information.</i>
236
- * </p>
201
+ * <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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
237
202
  * @public
238
203
  */
239
204
  attributes?: Record<string, string> | undefined;
240
205
  /**
241
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
242
- * (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
243
- * Editor</i> for details, including restrictions that apply to tags and "Tag naming
244
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
245
- * there.</p>
206
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
246
207
  * @public
247
208
  */
248
209
  tags?: Record<string, string> | undefined;
@@ -251,6 +212,41 @@ export interface IngestConfiguration {
251
212
  * @public
252
213
  */
253
214
  export interface CreateIngestConfigurationResponse {
215
+ /**
216
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Access-Control-Allow-Origin">Access-Control-Allow-Origin</a> in the MDN Web Docs.</p>
217
+ * @public
218
+ */
219
+ accessControlAllowOrigin?: string | undefined;
220
+ /**
221
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Access-Control-Expose-Headers">Access-Control-Expose-Headers</a> in the MDN Web Docs.</p>
222
+ * @public
223
+ */
224
+ accessControlExposeHeaders?: string | undefined;
225
+ /**
226
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cache-Control">Cache-Control</a> in the MDN Web Docs.</p>
227
+ * @public
228
+ */
229
+ cacheControl?: string | undefined;
230
+ /**
231
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Security-Policy">Content-Security-Policy</a> in the MDN Web Docs.</p>
232
+ * @public
233
+ */
234
+ contentSecurityPolicy?: string | undefined;
235
+ /**
236
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Strict-Transport-Security">Strict-Transport-Security</a> in the MDN Web Docs.</p>
237
+ * @public
238
+ */
239
+ strictTransportSecurity?: string | undefined;
240
+ /**
241
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/X-Content-Type-Options">X-Content-Type-Options</a> in the MDN Web Docs.</p>
242
+ * @public
243
+ */
244
+ xContentTypeOptions?: string | undefined;
245
+ /**
246
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/X-Frame-Options">X-Frame-Options</a> in the MDN Web Docs.</p>
247
+ * @public
248
+ */
249
+ xFrameOptions?: string | undefined;
254
250
  /**
255
251
  * <p>The IngestConfiguration that was created.</p>
256
252
  * @public
@@ -272,35 +268,23 @@ export interface CreateParticipantTokenRequest {
272
268
  */
273
269
  duration?: number | undefined;
274
270
  /**
275
- * <p>Name that can be specified to help identify the token. This can be any UTF-8 encoded
276
- * text. <i>This field is exposed to all stage participants and should not be used for
277
- * personally identifying, confidential, or sensitive information.</i>
278
- * </p>
271
+ * <p>Name that can be specified to help identify the token. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
279
272
  * @public
280
273
  */
281
274
  userId?: string | undefined;
282
275
  /**
283
- * <p>Application-provided attributes to encode into the token and attach to a stage. Map keys
284
- * and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
285
- * <i>This field is exposed to all stage participants and should not be used for
286
- * personally identifying, confidential, or sensitive information.</i>
287
- * </p>
276
+ * <p>Application-provided attributes to encode into the token 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
288
277
  * @public
289
278
  */
290
279
  attributes?: Record<string, string> | undefined;
291
280
  /**
292
- * <p>Set of capabilities that the user is allowed to perform in the stage. Default:
293
- * <code>PUBLISH, SUBSCRIBE</code>.</p>
281
+ * <p>Set of capabilities that the user is allowed to perform in the stage. Default: <code>PUBLISH, SUBSCRIBE</code>.</p>
294
282
  * @public
295
283
  */
296
284
  capabilities?: ParticipantTokenCapability[] | undefined;
297
285
  }
298
286
  /**
299
- * <p>Object specifying a participant token in a stage.</p>
300
- * <p>
301
- * <b>Important</b>: Treat tokens as opaque; i.e., do not build
302
- * functionality based on token contents. The format of tokens could change in the
303
- * future.</p>
287
+ * <p>Object specifying a participant token in a stage.</p> <p> <b>Important</b>: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.</p>
304
288
  * @public
305
289
  */
306
290
  export interface ParticipantToken {
@@ -315,27 +299,17 @@ export interface ParticipantToken {
315
299
  */
316
300
  token?: string | undefined;
317
301
  /**
318
- * <p>Customer-assigned name to help identify the token; this can be used to link a
319
- * participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
320
- * <i>This field is exposed to all stage participants and should not be used for
321
- * personally identifying, confidential, or sensitive information.</i>
322
- * </p>
302
+ * <p>Customer-assigned name to help identify the token; 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
323
303
  * @public
324
304
  */
325
305
  userId?: string | undefined;
326
306
  /**
327
- * <p>Application-provided attributes to encode into the token and attach to a
328
- * stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field
329
- * is 1 KB total. <i>This field is exposed to all stage participants and should not be
330
- * used for personally identifying, confidential, or sensitive
331
- * information.</i>
332
- * </p>
307
+ * <p>Application-provided attributes to encode into the token 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
333
308
  * @public
334
309
  */
335
310
  attributes?: Record<string, string> | undefined;
336
311
  /**
337
- * <p>Duration (in minutes), after which the participant token expires. Default: 720 (12
338
- * hours).</p>
312
+ * <p>Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).</p>
339
313
  * @public
340
314
  */
341
315
  duration?: number | undefined;
@@ -366,32 +340,23 @@ export interface CreateParticipantTokenResponse {
366
340
  */
367
341
  export interface ParticipantRecordingHlsConfiguration {
368
342
  /**
369
- * <p>Defines the target duration for recorded segments generated when recording a stage participant.
370
- * Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe.
371
- * Default: 6.</p>
343
+ * <p>Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.</p>
372
344
  * @public
373
345
  */
374
346
  targetSegmentDurationSeconds?: number | undefined;
375
347
  }
376
348
  /**
377
- * <p>An object representing a configuration of thumbnails for recorded video from an
378
- * individual participant.</p>
349
+ * <p>An object representing a configuration of thumbnails for recorded video from an individual participant.</p>
379
350
  * @public
380
351
  */
381
352
  export interface ParticipantThumbnailConfiguration {
382
353
  /**
383
- * <p>The targeted thumbnail-generation interval in seconds. This is configurable only if
384
- * <code>recordingMode</code> is <code>INTERVAL</code>. Default: 60.</p>
354
+ * <p>The targeted thumbnail-generation interval in seconds. This is configurable only if <code>recordingMode</code> is <code>INTERVAL</code>. Default: 60.</p>
385
355
  * @public
386
356
  */
387
357
  targetIntervalSeconds?: number | undefined;
388
358
  /**
389
- * <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records
390
- * all generated thumbnails in a serial manner, to the media/thumbnails/high directory.
391
- * <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg
392
- * and overwrites it at the interval specified by <code>targetIntervalSeconds</code>. You can
393
- * enable both <code>SEQUENTIAL</code> and <code>LATEST</code>. Default:
394
- * <code>SEQUENTIAL</code>.</p>
359
+ * <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by <code>targetIntervalSeconds</code>. You can enable both <code>SEQUENTIAL</code> and <code>LATEST</code>. Default: <code>SEQUENTIAL</code>.</p>
395
360
  * @public
396
361
  */
397
362
  storage?: ThumbnailStorageType[] | undefined;
@@ -407,12 +372,7 @@ export interface ParticipantThumbnailConfiguration {
407
372
  */
408
373
  export interface AutoParticipantRecordingConfiguration {
409
374
  /**
410
- * <p>ARN of the <a>StorageConfiguration</a> resource to use for individual
411
- * participant recording. Default: <code>""</code> (empty string, no storage configuration is
412
- * specified). Individual participant recording cannot be started unless a storage
413
- * configuration is specified, when a <a>Stage</a> is created or updated. To
414
- * disable individual participant recording, set this to <code>""</code>; other fields in this object will
415
- * get reset to their defaults when sending <code>""</code>. </p>
375
+ * <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. To disable individual participant recording, set this to <code>""</code>; other fields in this object will get reset to their defaults when sending <code>""</code>. </p>
416
376
  * @public
417
377
  */
418
378
  storageConfigurationArn: string | undefined;
@@ -422,16 +382,12 @@ export interface AutoParticipantRecordingConfiguration {
422
382
  */
423
383
  mediaTypes?: ParticipantRecordingMediaType[] | undefined;
424
384
  /**
425
- * <p>A complex type that allows you to enable/disable the recording of thumbnails for
426
- * individual participant recording and modify the interval at which thumbnails are generated
427
- * for the live session.</p>
385
+ * <p>A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.</p>
428
386
  * @public
429
387
  */
430
388
  thumbnailConfiguration?: ParticipantThumbnailConfiguration | undefined;
431
389
  /**
432
- * <p>If a stage publisher disconnects and then reconnects within the specified interval,
433
- * the multiple recordings will be considered a single recording and merged together.</p>
434
- * <p>The default value is 0, which disables merging.</p>
390
+ * <p>If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together.</p> <p>The default value is 0, which disables merging.</p>
435
391
  * @public
436
392
  */
437
393
  recordingReconnectWindowSeconds?: number | undefined;
@@ -441,8 +397,7 @@ export interface AutoParticipantRecordingConfiguration {
441
397
  */
442
398
  hlsConfiguration?: ParticipantRecordingHlsConfiguration | undefined;
443
399
  /**
444
- * <p>Optional field to disable replica participant recording. If this is set to <code>false</code> when a
445
- * participant is a replica, replica participants are not recorded. Default: <code>true</code>.</p>
400
+ * <p>Optional field to disable replica participant recording. If this is set to <code>false</code> when a participant is a replica, replica participants are not recorded. Default: <code>true</code>.</p>
446
401
  * @public
447
402
  */
448
403
  recordParticipantReplicas?: boolean | undefined;
@@ -453,27 +408,17 @@ export interface AutoParticipantRecordingConfiguration {
453
408
  */
454
409
  export interface ParticipantTokenConfiguration {
455
410
  /**
456
- * <p>Duration (in minutes), after which the corresponding participant token expires. Default:
457
- * 720 (12 hours).</p>
411
+ * <p>Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).</p>
458
412
  * @public
459
413
  */
460
414
  duration?: number | undefined;
461
415
  /**
462
- * <p>Customer-assigned name to help identify the token; this can be used to link a
463
- * participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
464
- * <i>This field is exposed to all stage participants and should not be used for
465
- * personally identifying, confidential, or sensitive information.</i>
466
- * </p>
416
+ * <p>Customer-assigned name to help identify the token; 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
467
417
  * @public
468
418
  */
469
419
  userId?: string | undefined;
470
420
  /**
471
- * <p>Application-provided attributes to encode into the corresponding participant token and
472
- * attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length
473
- * of this field is 1 KB total. <i>This field is exposed to all stage participants and
474
- * should not be used for personally identifying, confidential, or sensitive
475
- * information.</i>
476
- * </p>
421
+ * <p>Application-provided attributes to encode into the corresponding participant token 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
477
422
  * @public
478
423
  */
479
424
  attributes?: Record<string, string> | undefined;
@@ -498,11 +443,7 @@ export interface CreateStageRequest {
498
443
  */
499
444
  participantTokenConfigurations?: ParticipantTokenConfiguration[] | undefined;
500
445
  /**
501
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
502
- * (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>
503
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
504
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
505
- * there. </p>
446
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there. </p>
506
447
  * @public
507
448
  */
508
449
  tags?: Record<string, string> | undefined;
@@ -513,8 +454,7 @@ export interface CreateStageRequest {
513
454
  autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration | undefined;
514
455
  }
515
456
  /**
516
- * <p>Summary information about various endpoints for a stage. We recommend that you cache
517
- * these values at stage creation; the values can be cached for up to 14 days.</p>
457
+ * <p>Summary information about various endpoints for a stage. We recommend that you cache these values at stage creation; the values can be cached for up to 14 days.</p>
518
458
  * @public
519
459
  */
520
460
  export interface StageEndpoints {
@@ -560,11 +500,7 @@ export interface Stage {
560
500
  */
561
501
  activeSessionId?: string | undefined;
562
502
  /**
563
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
564
- * (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
565
- * Editor</i> for details, including restrictions that apply to tags and "Tag naming
566
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
567
- * there.</p>
503
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
568
504
  * @public
569
505
  */
570
506
  tags?: Record<string, string> | undefined;
@@ -589,21 +525,18 @@ export interface CreateStageResponse {
589
525
  */
590
526
  stage?: Stage | undefined;
591
527
  /**
592
- * <p>Participant tokens attached to the stage. These correspond to the
593
- * <code>participants</code> in the request.</p>
528
+ * <p>Participant tokens attached to the stage. These correspond to the <code>participants</code> in the request.</p>
594
529
  * @public
595
530
  */
596
531
  participantTokens?: ParticipantToken[] | undefined;
597
532
  }
598
533
  /**
599
- * <p>A complex type that describes an S3 location where recorded videos will be
600
- * stored.</p>
534
+ * <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
601
535
  * @public
602
536
  */
603
537
  export interface S3StorageConfiguration {
604
538
  /**
605
- * <p>Location (S3 bucket name) where recorded videos will be stored. Note that the
606
- * StorageConfiguration and S3 bucket must be in the same region as the Composition.</p>
539
+ * <p>Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.</p>
607
540
  * @public
608
541
  */
609
542
  bucketName: string | undefined;
@@ -623,11 +556,7 @@ export interface CreateStorageConfigurationRequest {
623
556
  */
624
557
  s3: S3StorageConfiguration | undefined;
625
558
  /**
626
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
627
- * (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>
628
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
629
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
630
- * there.</p>
559
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
631
560
  * @public
632
561
  */
633
562
  tags?: Record<string, string> | undefined;
@@ -653,11 +582,7 @@ export interface StorageConfiguration {
653
582
  */
654
583
  s3?: S3StorageConfiguration | undefined;
655
584
  /**
656
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
657
- * (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
658
- * Editor</i> for details, including restrictions that apply to tags and "Tag naming
659
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
660
- * there.</p>
585
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
661
586
  * @public
662
587
  */
663
588
  tags?: Record<string, string> | undefined;
@@ -762,9 +687,7 @@ export interface DisconnectParticipantRequest {
762
687
  */
763
688
  stageArn: string | undefined;
764
689
  /**
765
- * <p>Identifier of the participant to be disconnected. IVS assigns this; it is returned
766
- * by <a>CreateParticipantToken</a> (for streams using WebRTC ingest) or <a>CreateIngestConfiguration</a> (for
767
- * streams using RTMP ingest).</p>
690
+ * <p>Identifier of the participant to be disconnected. IVS assigns this; it is returned by <a>CreateParticipantToken</a> (for streams using WebRTC ingest) or <a>CreateIngestConfiguration</a> (for streams using RTMP ingest).</p>
768
691
  * @public
769
692
  */
770
693
  participantId: string | undefined;
@@ -795,14 +718,12 @@ export interface GetCompositionRequest {
795
718
  */
796
719
  export interface ChannelDestinationConfiguration {
797
720
  /**
798
- * <p>ARN of the channel to use for broadcasting. The channel and stage resources must be in
799
- * the same AWS account and region. The channel must be offline (not broadcasting).</p>
721
+ * <p>ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).</p>
800
722
  * @public
801
723
  */
802
724
  channelArn: string | undefined;
803
725
  /**
804
- * <p>ARN of the <a>EncoderConfiguration</a> resource. The encoder configuration
805
- * and stage resources must be in the same AWS account and region.</p>
726
+ * <p>ARN of the <a>EncoderConfiguration</a> resource. The encoder configuration and stage resources must be in the same AWS account and region.</p>
806
727
  * @public
807
728
  */
808
729
  encoderConfigurationArn?: string | undefined;
@@ -845,46 +766,33 @@ export interface CompositionThumbnailConfiguration {
845
766
  */
846
767
  targetIntervalSeconds?: number | undefined;
847
768
  /**
848
- * <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records
849
- * all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height)
850
- * directory, where (width) and (height) are the width and height of the thumbnail.
851
- * <code>LATEST</code> saves the latest thumbnail in
852
- * media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval
853
- * specified by <code>targetIntervalSeconds</code>. You can enable both
854
- * <code>SEQUENTIAL</code> and <code>LATEST</code>. Default:
855
- * <code>SEQUENTIAL</code>.</p>
769
+ * <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height) directory, where (width) and (height) are the width and height of the thumbnail. <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval specified by <code>targetIntervalSeconds</code>. You can enable both <code>SEQUENTIAL</code> and <code>LATEST</code>. Default: <code>SEQUENTIAL</code>.</p>
856
770
  * @public
857
771
  */
858
772
  storage?: ThumbnailStorageType[] | undefined;
859
773
  }
860
774
  /**
861
- * <p>A complex type that describes an S3 location where recorded videos will be
862
- * stored.</p>
775
+ * <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
863
776
  * @public
864
777
  */
865
778
  export interface S3DestinationConfiguration {
866
779
  /**
867
- * <p>ARN of the <a>StorageConfiguration</a> where recorded videos will be
868
- * stored.</p>
780
+ * <p>ARN of the <a>StorageConfiguration</a> where recorded videos will be stored.</p>
869
781
  * @public
870
782
  */
871
783
  storageConfigurationArn: string | undefined;
872
784
  /**
873
- * <p>ARNs of the <a>EncoderConfiguration</a> resource. The encoder configuration
874
- * and stage resources must be in the same AWS account and region. </p>
785
+ * <p>ARNs of the <a>EncoderConfiguration</a> resource. The encoder configuration and stage resources must be in the same AWS account and region. </p>
875
786
  * @public
876
787
  */
877
788
  encoderConfigurationArns: string[] | undefined;
878
789
  /**
879
- * <p>Array of maps, each of the form <code>string:string (key:value)</code>. This is an
880
- * optional customer specification, currently used only to specify the recording format for
881
- * storing a recording in Amazon S3.</p>
790
+ * <p>Array of maps, each of the form <code>string:string (key:value)</code>. This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.</p>
882
791
  * @public
883
792
  */
884
793
  recordingConfiguration?: RecordingConfiguration | undefined;
885
794
  /**
886
- * <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
887
- * the live session.</p>
795
+ * <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 the live session.</p>
888
796
  * @public
889
797
  */
890
798
  thumbnailConfigurations?: CompositionThumbnailConfiguration[] | undefined;
@@ -900,14 +808,12 @@ export interface DestinationConfiguration {
900
808
  */
901
809
  name?: string | undefined;
902
810
  /**
903
- * <p>An IVS channel to be used for broadcasting, for server-side composition. Either a
904
- * <code>channel</code> or an <code>s3</code> must be specified. </p>
811
+ * <p>An IVS channel to be used for broadcasting, for server-side composition. Either a <code>channel</code> or an <code>s3</code> must be specified. </p>
905
812
  * @public
906
813
  */
907
814
  channel?: ChannelDestinationConfiguration | undefined;
908
815
  /**
909
- * <p>An S3 storage configuration to be used for recording video data. Either a
910
- * <code>channel</code> or an <code>s3</code> must be specified.</p>
816
+ * <p>An S3 storage configuration to be used for recording video data. Either a <code>channel</code> or an <code>s3</code> must be specified.</p>
911
817
  * @public
912
818
  */
913
819
  s3?: S3DestinationConfiguration | undefined;
@@ -950,14 +856,12 @@ export interface Destination {
950
856
  */
951
857
  state: DestinationState | undefined;
952
858
  /**
953
- * <p>UTC time of the destination start. This is an ISO 8601 timestamp; <i>note that
954
- * this is returned as a string</i>.</p>
859
+ * <p>UTC time of the destination start. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>
955
860
  * @public
956
861
  */
957
862
  startTime?: Date | undefined;
958
863
  /**
959
- * <p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this
960
- * is returned as a string</i>.</p>
864
+ * <p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>
961
865
  * @public
962
866
  */
963
867
  endTime?: Date | undefined;
@@ -973,50 +877,37 @@ export interface Destination {
973
877
  detail?: DestinationDetail | undefined;
974
878
  }
975
879
  /**
976
- * <p>Configuration information specific to Grid layout, for server-side composition. See
977
- * "Layouts" in <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html">Server-Side
978
- * Composition</a>.</p>
880
+ * <p>Configuration information specific to Grid layout, for server-side composition. See "Layouts" in <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html">Server-Side Composition</a>.</p>
979
881
  * @public
980
882
  */
981
883
  export interface GridConfiguration {
982
884
  /**
983
- * <p>This attribute name identifies the featured slot. A participant with this attribute set
984
- * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured slot. Default: <code>""</code> (no featured
985
- * participant).</p>
885
+ * <p>This attribute name identifies the featured slot. A participant with this attribute set to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured slot. Default: <code>""</code> (no featured participant).</p>
986
886
  * @public
987
887
  */
988
888
  featuredParticipantAttribute?: string | undefined;
989
889
  /**
990
- * <p>Determines whether to omit participants with stopped video in the composition. Default:
991
- * <code>false</code>.</p>
890
+ * <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
992
891
  * @public
993
892
  */
994
893
  omitStoppedVideo?: boolean | undefined;
995
894
  /**
996
- * <p>Sets the non-featured participant display mode, to control the aspect ratio of video
997
- * tiles. <code>VIDEO</code> is 16:9, <code>SQUARE</code> is 1:1, and <code>PORTRAIT</code> is
998
- * 3:4. Default: <code>VIDEO</code>.</p>
895
+ * <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>
999
896
  * @public
1000
897
  */
1001
898
  videoAspectRatio?: VideoAspectRatio | undefined;
1002
899
  /**
1003
- * <p>Defines how video content fits within the participant tile: <code>FILL</code>
1004
- * (stretched), <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). When not
1005
- * set, <code>videoFillMode</code> defaults to <code>COVER</code> fill mode for participants
1006
- * in the grid and to <code>CONTAIN</code> fill mode for featured participants.</p>
900
+ * <p>Defines how video content fits within the participant tile: <code>FILL</code> (stretched), <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). When not set, <code>videoFillMode</code> defaults to <code>COVER</code> fill mode for participants in the grid and to <code>CONTAIN</code> fill mode for featured participants.</p>
1007
901
  * @public
1008
902
  */
1009
903
  videoFillMode?: VideoFillMode | undefined;
1010
904
  /**
1011
- * <p>Specifies the spacing between participant tiles in pixels. Default:
1012
- * <code>2</code>.</p>
905
+ * <p>Specifies the spacing between participant tiles in pixels. Default: <code>2</code>.</p>
1013
906
  * @public
1014
907
  */
1015
908
  gridGap?: number | undefined;
1016
909
  /**
1017
- * <p>Attribute name in <a>ParticipantTokenConfiguration</a> identifying the participant ordering key.
1018
- * Participants with <code>participantOrderAttribute</code> set to <code>""</code> or not specified are ordered based
1019
- * on their arrival time into the stage.</p>
910
+ * <p>Attribute name in <a>ParticipantTokenConfiguration</a> identifying the participant ordering key. Participants with <code>participantOrderAttribute</code> set to <code>""</code> or not specified are ordered based on their arrival time into the stage.</p>
1020
911
  * @public
1021
912
  */
1022
913
  participantOrderAttribute?: string | undefined;
@@ -1027,74 +918,57 @@ export interface GridConfiguration {
1027
918
  */
1028
919
  export interface PipConfiguration {
1029
920
  /**
1030
- * <p>This attribute name identifies the featured slot. A participant with this attribute set
1031
- * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured slot. Default: <code>""</code> (no featured
1032
- * participant).</p>
921
+ * <p>This attribute name identifies the featured slot. A participant with this attribute set to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured slot. Default: <code>""</code> (no featured participant).</p>
1033
922
  * @public
1034
923
  */
1035
924
  featuredParticipantAttribute?: string | undefined;
1036
925
  /**
1037
- * <p>Determines whether to omit participants with stopped video in the composition. Default:
1038
- * <code>false</code>.</p>
926
+ * <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
1039
927
  * @public
1040
928
  */
1041
929
  omitStoppedVideo?: boolean | undefined;
1042
930
  /**
1043
- * <p>Defines how video content fits within the participant tile: <code>FILL</code>
1044
- * (stretched), <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). Default:
1045
- * <code>COVER</code>.</p>
931
+ * <p>Defines how video content fits within the participant tile: <code>FILL</code> (stretched), <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). Default: <code>COVER</code>.</p>
1046
932
  * @public
1047
933
  */
1048
934
  videoFillMode?: VideoFillMode | undefined;
1049
935
  /**
1050
- * <p>Specifies the spacing between participant tiles in pixels. Default:
1051
- * <code>0</code>.</p>
936
+ * <p>Specifies the spacing between participant tiles in pixels. Default: <code>0</code>.</p>
1052
937
  * @public
1053
938
  */
1054
939
  gridGap?: number | undefined;
1055
940
  /**
1056
- * <p>Specifies the participant for the PiP window. A participant with this attribute set to
1057
- * <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the PiP slot. Default: <code>""</code> (no PiP participant).</p>
941
+ * <p>Specifies the participant for the PiP window. A participant with this attribute set to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the PiP slot. Default: <code>""</code> (no PiP participant).</p>
1058
942
  * @public
1059
943
  */
1060
944
  pipParticipantAttribute?: string | undefined;
1061
945
  /**
1062
- * <p>Defines PiP behavior when all participants have left: <code>STATIC</code> (maintains
1063
- * original position/size) or <code>DYNAMIC</code> (expands to full composition). Default:
1064
- * <code>STATIC</code>.</p>
946
+ * <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>
1065
947
  * @public
1066
948
  */
1067
949
  pipBehavior?: PipBehavior | undefined;
1068
950
  /**
1069
- * <p>Sets the PiP window’s offset position in pixels from the closest edges determined by
1070
- * <code>PipPosition</code>. Default: <code>0</code>.</p>
951
+ * <p>Sets the PiP window’s offset position in pixels from the closest edges determined by <code>PipPosition</code>. Default: <code>0</code>.</p>
1071
952
  * @public
1072
953
  */
1073
954
  pipOffset?: number | undefined;
1074
955
  /**
1075
- * <p>Determines the corner position of the PiP window. Default:
1076
- * <code>BOTTOM_RIGHT</code>.</p>
956
+ * <p>Determines the corner position of the PiP window. Default: <code>BOTTOM_RIGHT</code>.</p>
1077
957
  * @public
1078
958
  */
1079
959
  pipPosition?: PipPosition | undefined;
1080
960
  /**
1081
- * <p>Specifies the width of the PiP window in pixels. When this is not set explicitly,
1082
- * <code>pipWidth</code>’s value will be based on the size of the composition and the
1083
- * aspect ratio of the participant’s video.</p>
961
+ * <p>Specifies the width of the PiP window in pixels. When this is not set explicitly, <code>pipWidth</code>’s value will be based on the size of the composition and the aspect ratio of the participant’s video.</p>
1084
962
  * @public
1085
963
  */
1086
964
  pipWidth?: number | undefined;
1087
965
  /**
1088
- * <p>Specifies the height of the PiP window in pixels. When this is not set explicitly,
1089
- * <code>pipHeight</code>’s value will be based on the size of the composition and the
1090
- * aspect ratio of the participant’s video.</p>
966
+ * <p>Specifies the height of the PiP window in pixels. When this is not set explicitly, <code>pipHeight</code>’s value will be based on the size of the composition and the aspect ratio of the participant’s video.</p>
1091
967
  * @public
1092
968
  */
1093
969
  pipHeight?: number | undefined;
1094
970
  /**
1095
- * <p>Attribute name in <a>ParticipantTokenConfiguration</a> identifying the participant ordering key.
1096
- * Participants with <code>participantOrderAttribute</code> set to <code>""</code> or not specified are ordered based
1097
- * on their arrival time into the stage.</p>
971
+ * <p>Attribute name in <a>ParticipantTokenConfiguration</a> identifying the participant ordering key. Participants with <code>participantOrderAttribute</code> set to <code>""</code> or not specified are ordered based on their arrival time into the stage.</p>
1098
972
  * @public
1099
973
  */
1100
974
  participantOrderAttribute?: string | undefined;
@@ -1141,30 +1015,22 @@ export interface Composition {
1141
1015
  */
1142
1016
  layout: LayoutConfiguration | undefined;
1143
1017
  /**
1144
- * <p>Array of Destination objects. A Composition can contain either one destination
1145
- * (<code>channel</code> or <code>s3</code>) or two (one <code>channel</code> and one
1146
- * <code>s3</code>).</p>
1018
+ * <p>Array of Destination objects. A Composition can contain either one destination (<code>channel</code> or <code>s3</code>) or two (one <code>channel</code> and one <code>s3</code>).</p>
1147
1019
  * @public
1148
1020
  */
1149
1021
  destinations: Destination[] | undefined;
1150
1022
  /**
1151
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1152
- * (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
1153
- * Editor</i> for details, including restrictions that apply to tags and "Tag naming
1154
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1155
- * there.</p>
1023
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
1156
1024
  * @public
1157
1025
  */
1158
1026
  tags?: Record<string, string> | undefined;
1159
1027
  /**
1160
- * <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
1161
- * this is returned as a string</i>.</p>
1028
+ * <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>
1162
1029
  * @public
1163
1030
  */
1164
1031
  startTime?: Date | undefined;
1165
1032
  /**
1166
- * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that this
1167
- * is returned as a string</i>.</p>
1033
+ * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>
1168
1034
  * @public
1169
1035
  */
1170
1036
  endTime?: Date | undefined;
@@ -1250,10 +1116,7 @@ export interface Participant {
1250
1116
  */
1251
1117
  participantId?: string | undefined;
1252
1118
  /**
1253
- * <p>Customer-assigned name to help identify the token; this can be used to link a
1254
- * participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
1255
- * <i>This field is exposed to all stage participants and should not be used for
1256
- * personally identifying, confidential, or sensitive information</i>.</p>
1119
+ * <p>Customer-assigned name to help identify the token; 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information</i>.</p>
1257
1120
  * @public
1258
1121
  */
1259
1122
  userId?: string | undefined;
@@ -1263,16 +1126,12 @@ export interface Participant {
1263
1126
  */
1264
1127
  state?: ParticipantState | undefined;
1265
1128
  /**
1266
- * <p>ISO 8601 timestamp (returned as a string) when the participant first joined the stage
1267
- * session.</p>
1129
+ * <p>ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.</p>
1268
1130
  * @public
1269
1131
  */
1270
1132
  firstJoinTime?: Date | undefined;
1271
1133
  /**
1272
- * <p>Application-provided attributes to encode into the token and attach to a stage. Map keys
1273
- * and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
1274
- * <i>This field is exposed to all stage participants and should not be used for
1275
- * personally identifying, confidential, or sensitive information</i>.</p>
1134
+ * <p>Application-provided attributes to encode into the token 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information</i>.</p>
1276
1135
  * @public
1277
1136
  */
1278
1137
  attributes?: Record<string, string> | undefined;
@@ -1312,20 +1171,12 @@ export interface Participant {
1312
1171
  */
1313
1172
  sdkVersion?: string | undefined;
1314
1173
  /**
1315
- * <p>Name of the S3 bucket to where the participant is being recorded, if individual
1316
- * participant recording is enabled, or <code>""</code> (empty string), if recording is not
1317
- * enabled.</p>
1174
+ * <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>
1318
1175
  * @public
1319
1176
  */
1320
1177
  recordingS3BucketName?: string | undefined;
1321
1178
  /**
1322
- * <p>S3 prefix of the S3 bucket where the participant is being recorded, if individual
1323
- * participant recording is enabled, or <code>""</code> (empty string), if recording is not
1324
- * enabled. If individual participant recording merge is enabled, and if a stage publisher
1325
- * disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as
1326
- * the previous session. See
1327
- * <a href="/ivs/latest/RealTimeUserGuide/rt-individual-participant-recording.html#ind-part-rec-merge-frag">
1328
- * Merge Fragmented Individual Participant Recordings</a>.</p>
1179
+ * <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. If individual participant recording merge is enabled, and if a stage publisher disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as the previous session. See <a href="/ivs/latest/RealTimeUserGuide/rt-individual-participant-recording.html#ind-part-rec-merge-frag"> Merge Fragmented Individual Participant Recordings</a>.</p>
1329
1180
  * @public
1330
1181
  */
1331
1182
  recordingS3Prefix?: string | undefined;
@@ -1350,8 +1201,7 @@ export interface Participant {
1350
1201
  */
1351
1202
  replicationState?: ReplicationState | undefined;
1352
1203
  /**
1353
- * <p>Source stage ARN from which this participant is replicated, if <code>replicationType</code> is <code>REPLICA</code>.
1354
- * </p>
1204
+ * <p>Source stage ARN from which this participant is replicated, if <code>replicationType</code> is <code>REPLICA</code>. </p>
1355
1205
  * @public
1356
1206
  */
1357
1207
  sourceStageArn?: string | undefined;
@@ -1412,17 +1262,12 @@ export interface PublicKey {
1412
1262
  */
1413
1263
  publicKeyMaterial?: string | undefined;
1414
1264
  /**
1415
- * <p>The public key fingerprint, a short string used to identify or verify the full public
1416
- * key.</p>
1265
+ * <p>The public key fingerprint, a short string used to identify or verify the full public key.</p>
1417
1266
  * @public
1418
1267
  */
1419
1268
  fingerprint?: string | undefined;
1420
1269
  /**
1421
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1422
- * (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
1423
- * Editor</i> for details, including restrictions that apply to tags and "Tag naming
1424
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1425
- * there.</p>
1270
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
1426
1271
  * @public
1427
1272
  */
1428
1273
  tags?: Record<string, string> | undefined;
@@ -1473,10 +1318,7 @@ export interface GetStageSessionRequest {
1473
1318
  sessionId: string | undefined;
1474
1319
  }
1475
1320
  /**
1476
- * <p>A stage session begins when the first participant joins a stage and ends after the last
1477
- * participant leaves the stage. A stage session helps with debugging stages by grouping
1478
- * events and participants into shorter periods of time (i.e., a session), which is helpful
1479
- * when stages are used over long periods of time.</p>
1321
+ * <p>A stage session begins when the first participant joins a stage and ends after the last participant leaves the stage. A stage session helps with debugging stages by grouping events and participants into shorter periods of time (i.e., a session), which is helpful when stages are used over long periods of time.</p>
1480
1322
  * @public
1481
1323
  */
1482
1324
  export interface StageSession {
@@ -1491,8 +1333,7 @@ export interface StageSession {
1491
1333
  */
1492
1334
  startTime?: Date | undefined;
1493
1335
  /**
1494
- * <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if
1495
- * the stage is active.</p>
1336
+ * <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.</p>
1496
1337
  * @public
1497
1338
  */
1498
1339
  endTime?: Date | undefined;
@@ -1542,11 +1383,7 @@ export interface ImportPublicKeyRequest {
1542
1383
  */
1543
1384
  name?: string | undefined;
1544
1385
  /**
1545
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1546
- * (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>
1547
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
1548
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1549
- * there.</p>
1386
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
1550
1387
  * @public
1551
1388
  */
1552
1389
  tags?: Record<string, string> | undefined;
@@ -1571,14 +1408,12 @@ export interface ListCompositionsRequest {
1571
1408
  */
1572
1409
  filterByStageArn?: string | undefined;
1573
1410
  /**
1574
- * <p>Filters the Composition list to match the specified EncoderConfiguration attached to at
1575
- * least one of its output.</p>
1411
+ * <p>Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.</p>
1576
1412
  * @public
1577
1413
  */
1578
1414
  filterByEncoderConfigurationArn?: string | undefined;
1579
1415
  /**
1580
- * <p>The first Composition to retrieve. This is used for pagination; see the
1581
- * <code>nextToken</code> response field.</p>
1416
+ * <p>The first Composition to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
1582
1417
  * @public
1583
1418
  */
1584
1419
  nextToken?: string | undefined;
@@ -1604,14 +1439,12 @@ export interface DestinationSummary {
1604
1439
  */
1605
1440
  state: DestinationState | undefined;
1606
1441
  /**
1607
- * <p>UTC time of the destination start. This is an ISO 8601 timestamp; <i>note that
1608
- * this is returned as a string</i>.</p>
1442
+ * <p>UTC time of the destination start. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>
1609
1443
  * @public
1610
1444
  */
1611
1445
  startTime?: Date | undefined;
1612
1446
  /**
1613
- * <p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this
1614
- * is returned as a string</i>.</p>
1447
+ * <p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>
1615
1448
  * @public
1616
1449
  */
1617
1450
  endTime?: Date | undefined;
@@ -1642,23 +1475,17 @@ export interface CompositionSummary {
1642
1475
  */
1643
1476
  state: CompositionState | undefined;
1644
1477
  /**
1645
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1646
- * (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
1647
- * Editor</i> for details, including restrictions that apply to tags and "Tag naming
1648
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1649
- * there.</p>
1478
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
1650
1479
  * @public
1651
1480
  */
1652
1481
  tags?: Record<string, string> | undefined;
1653
1482
  /**
1654
- * <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
1655
- * this is returned as a string</i>.</p>
1483
+ * <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>
1656
1484
  * @public
1657
1485
  */
1658
1486
  startTime?: Date | undefined;
1659
1487
  /**
1660
- * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that this
1661
- * is returned as a string</i>.</p>
1488
+ * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>
1662
1489
  * @public
1663
1490
  */
1664
1491
  endTime?: Date | undefined;
@@ -1673,8 +1500,7 @@ export interface ListCompositionsResponse {
1673
1500
  */
1674
1501
  compositions: CompositionSummary[] | undefined;
1675
1502
  /**
1676
- * <p>If there are more compositions than <code>maxResults</code>, use <code>nextToken</code>
1677
- * in the request to get the next set.</p>
1503
+ * <p>If there are more compositions than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
1678
1504
  * @public
1679
1505
  */
1680
1506
  nextToken?: string | undefined;
@@ -1684,8 +1510,7 @@ export interface ListCompositionsResponse {
1684
1510
  */
1685
1511
  export interface ListEncoderConfigurationsRequest {
1686
1512
  /**
1687
- * <p>The first encoder configuration to retrieve. This is used for pagination; see the
1688
- * <code>nextToken</code> response field.</p>
1513
+ * <p>The first encoder configuration to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
1689
1514
  * @public
1690
1515
  */
1691
1516
  nextToken?: string | undefined;
@@ -1711,11 +1536,7 @@ export interface EncoderConfigurationSummary {
1711
1536
  */
1712
1537
  name?: string | undefined;
1713
1538
  /**
1714
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1715
- * (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
1716
- * Editor</i> for details, including restrictions that apply to tags and "Tag naming
1717
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1718
- * there.</p>
1539
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
1719
1540
  * @public
1720
1541
  */
1721
1542
  tags?: Record<string, string> | undefined;
@@ -1730,8 +1551,7 @@ export interface ListEncoderConfigurationsResponse {
1730
1551
  */
1731
1552
  encoderConfigurations: EncoderConfigurationSummary[] | undefined;
1732
1553
  /**
1733
- * <p>If there are more encoder configurations than <code>maxResults</code>, use
1734
- * <code>nextToken</code> in the request to get the next set.</p>
1554
+ * <p>If there are more encoder configurations than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
1735
1555
  * @public
1736
1556
  */
1737
1557
  nextToken?: string | undefined;
@@ -1792,18 +1612,12 @@ export interface IngestConfigurationSummary {
1792
1612
  */
1793
1613
  participantId: string | undefined;
1794
1614
  /**
1795
- * <p>State of the ingest configuration. It is <code>ACTIVE</code> if a publisher currently is
1796
- * publishing to the stage associated with the ingest configuration.</p>
1615
+ * <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>
1797
1616
  * @public
1798
1617
  */
1799
1618
  state: IngestConfigurationState | undefined;
1800
1619
  /**
1801
- * <p>Customer-assigned name to help identify the participant using the IngestConfiguration;
1802
- * this can be used to link a participant to a user in the customer’s own systems. This can be
1803
- * any UTF-8 encoded text. <i>This field is exposed to all stage participants and
1804
- * should not be used for personally identifying, confidential, or sensitive
1805
- * information.</i>
1806
- * </p>
1620
+ * <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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
1807
1621
  * @public
1808
1622
  */
1809
1623
  userId?: string | undefined;
@@ -1848,8 +1662,7 @@ export interface ListParticipantEventsRequest {
1848
1662
  */
1849
1663
  participantId: string | undefined;
1850
1664
  /**
1851
- * <p>The first participant event to retrieve. This is used for pagination; see the
1852
- * <code>nextToken</code> response field.</p>
1665
+ * <p>The first participant event to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
1853
1666
  * @public
1854
1667
  */
1855
1668
  nextToken?: string | undefined;
@@ -1860,11 +1673,7 @@ export interface ListParticipantEventsRequest {
1860
1673
  maxResults?: number | undefined;
1861
1674
  }
1862
1675
  /**
1863
- * <p>Object specifying an exchanged participant token in a stage, created when an original participant token is updated.</p>
1864
- * <p>
1865
- * <b>Important</b>: Treat tokens as opaque; i.e., do not build
1866
- * functionality based on token contents. The format of tokens could change in the
1867
- * future.</p>
1676
+ * <p>Object specifying an exchanged participant token in a stage, created when an original participant token is updated.</p> <p> <b>Important</b>: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.</p>
1868
1677
  * @public
1869
1678
  */
1870
1679
  export interface ExchangedParticipantToken {
@@ -1874,21 +1683,12 @@ export interface ExchangedParticipantToken {
1874
1683
  */
1875
1684
  capabilities?: ParticipantTokenCapability[] | undefined;
1876
1685
  /**
1877
- * <p>Application-provided attributes to encode into the token and attach to a
1878
- * stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field
1879
- * is 1 KB total. <i>This field is exposed to all stage participants and should not be
1880
- * used for personally identifying, confidential, or sensitive
1881
- * information.</i>
1882
- * </p>
1686
+ * <p>Application-provided attributes to encode into the token 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
1883
1687
  * @public
1884
1688
  */
1885
1689
  attributes?: Record<string, string> | undefined;
1886
1690
  /**
1887
- * <p>Customer-assigned name to help identify the token; this can be used to link a
1888
- * participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
1889
- * <i>This field is exposed to all stage participants and should not be used for
1890
- * personally identifying, confidential, or sensitive information.</i>
1891
- * </p>
1691
+ * <p>Customer-assigned name to help identify the token; 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>
1892
1692
  * @public
1893
1693
  */
1894
1694
  userId?: string | undefined;
@@ -1909,8 +1709,7 @@ export interface Event {
1909
1709
  */
1910
1710
  name?: EventName | undefined;
1911
1711
  /**
1912
- * <p>Unique identifier for the participant who triggered the event. This is assigned by
1913
- * IVS.</p>
1712
+ * <p>Unique identifier for the participant who triggered the event. This is assigned by IVS.</p>
1914
1713
  * @public
1915
1714
  */
1916
1715
  participantId?: string | undefined;
@@ -1920,116 +1719,27 @@ export interface Event {
1920
1719
  */
1921
1720
  eventTime?: Date | undefined;
1922
1721
  /**
1923
- * <p>Unique identifier for the remote participant. For a subscribe event, this is the
1924
- * publisher. For a publish or join event, this is null. This is assigned by IVS.</p>
1722
+ * <p>Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.</p>
1925
1723
  * @public
1926
1724
  */
1927
1725
  remoteParticipantId?: string | undefined;
1928
1726
  /**
1929
- * <p>If the event is an error event, the error code is provided to give insight into the
1930
- * specific error that occurred. If the event is not an error event, this field is
1931
- * null.</p>
1932
- * <ul>
1933
- * <li>
1934
- * <p>
1935
- * <code>B_FRAME_PRESENT</code> — The participant's stream includes B-frames.
1936
- * For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP
1937
- * Publishing</a>.</p>
1938
- * </li>
1939
- * <li>
1940
- * <p>
1941
- * <code>BITRATE_EXCEEDED</code> — The participant exceeded the maximum
1942
- * supported bitrate. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service
1943
- * Quotas</a>.</p>
1944
- * </li>
1945
- * <li>
1946
- * <p>
1947
- * <code>INSUFFICIENT_CAPABILITIES</code> — The participant tried to take an
1948
- * action that the participant’s token is not allowed to do. For details on participant
1949
- * capabilities, see the <code>capabilities</code> field in <a>CreateParticipantToken</a>.</p>
1950
- * </li>
1951
- * <li>
1952
- * <p>
1953
- * <code>INTERNAL_SERVER_EXCEPTION</code> — The participant failed to publish
1954
- * to the stage due to an internal server error.</p>
1955
- * </li>
1956
- * <li>
1957
- * <p>
1958
- * <code>INVALID_AUDIO_CODEC</code> — The participant is using an invalid audio
1959
- * codec. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html"> Stream
1960
- * Ingest</a>.</p>
1961
- * </li>
1962
- * <li>
1963
- * <p>
1964
- * <code>INVALID_INPUT</code> — The participant is using an invalid input
1965
- * stream.</p>
1966
- * </li>
1967
- * <li>
1968
- * <p>
1969
- * <code>INVALID_PROTOCOL</code> — The participant's IngestConfiguration
1970
- * resource is configured for RTMPS but they tried streaming with RTMP. For details, see
1971
- * <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP
1972
- * Publishing</a>.</p>
1973
- * </li>
1974
- * <li>
1975
- * <p>
1976
- * <code>INVALID_STREAM_KEY</code> — The participant is using an invalid stream
1977
- * key. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP
1978
- * Publishing</a>.</p>
1979
- * </li>
1980
- * <li>
1981
- * <p>
1982
- * <code>INVALID_VIDEO_CODEC</code> — The participant is using an invalid video
1983
- * codec. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html"> Stream
1984
- * Ingest</a>.</p>
1985
- * </li>
1986
- * <li>
1987
- * <p>
1988
- * <code>PUBLISHER_NOT_FOUND</code> — The participant tried to subscribe to a
1989
- * publisher that doesn’t exist.</p>
1990
- * </li>
1991
- * <li>
1992
- * <p>
1993
- * <code>QUOTA_EXCEEDED</code> — The number of participants who want to
1994
- * publish/subscribe to a stage exceeds the quota. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">
1995
- * Service Quotas</a>.</p>
1996
- * </li>
1997
- * <li>
1998
- * <p>
1999
- * <code>RESOLUTION_EXCEEDED</code> — The participant exceeded the maximum
2000
- * supported resolution. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service
2001
- * Quotas</a>.</p>
2002
- * </li>
2003
- * <li>
2004
- * <p>
2005
- * <code>REUSE_OF_STREAM_KEY</code> — The participant tried to use a stream key
2006
- * that is associated with another active stage session.</p>
2007
- * </li>
2008
- * <li>
2009
- * <p>
2010
- * <code>STREAM_DURATION_EXCEEDED</code> — The participant exceeded the maximum
2011
- * allowed stream duration. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service
2012
- * Quotas</a>.</p>
2013
- * </li>
2014
- * </ul>
1727
+ * <p>If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.</p> <ul> <li> <p> <code>B_FRAME_PRESENT</code> — The participant's stream includes B-frames. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP Publishing</a>.</p> </li> <li> <p> <code>BITRATE_EXCEEDED</code> — The participant exceeded the maximum supported bitrate. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service Quotas</a>.</p> </li> <li> <p> <code>INSUFFICIENT_CAPABILITIES</code> — The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see the <code>capabilities</code> field in <a>CreateParticipantToken</a>.</p> </li> <li> <p> <code>INTERNAL_SERVER_EXCEPTION</code> — The participant failed to publish to the stage due to an internal server error.</p> </li> <li> <p> <code>INVALID_AUDIO_CODEC</code> — The participant is using an invalid audio codec. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html"> Stream Ingest</a>.</p> </li> <li> <p> <code>INVALID_INPUT</code> — The participant is using an invalid input stream.</p> </li> <li> <p> <code>INVALID_PROTOCOL</code> — The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP Publishing</a>.</p> </li> <li> <p> <code>INVALID_STREAM_KEY</code> — The participant is using an invalid stream key. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html"> IVS RTMP Publishing</a>.</p> </li> <li> <p> <code>INVALID_VIDEO_CODEC</code> — The participant is using an invalid video codec. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html"> Stream Ingest</a>.</p> </li> <li> <p> <code>PUBLISHER_NOT_FOUND</code> — The participant tried to subscribe to a publisher that doesn’t exist.</p> </li> <li> <p> <code>QUOTA_EXCEEDED</code> — The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service Quotas</a>.</p> </li> <li> <p> <code>RESOLUTION_EXCEEDED</code> — The participant exceeded the maximum supported resolution. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service Quotas</a>.</p> </li> <li> <p> <code>REUSE_OF_STREAM_KEY</code> — The participant tried to use a stream key that is associated with another active stage session.</p> </li> <li> <p> <code>STREAM_DURATION_EXCEEDED</code> — The participant exceeded the maximum allowed stream duration. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html"> Service Quotas</a>.</p> </li> </ul>
2015
1728
  * @public
2016
1729
  */
2017
1730
  errorCode?: EventErrorCode | undefined;
2018
1731
  /**
2019
- * <p>ARN of the stage where the participant is replicated. Applicable only if the event name is
2020
- * <code>REPLICATION_STARTED</code> or <code>REPLICATION_STOPPED</code>.</p>
1732
+ * <p>ARN of the stage where the participant is replicated. Applicable only if the event name is <code>REPLICATION_STARTED</code> or <code>REPLICATION_STOPPED</code>.</p>
2021
1733
  * @public
2022
1734
  */
2023
1735
  destinationStageArn?: string | undefined;
2024
1736
  /**
2025
- * <p>ID of the session within the destination stage. Applicable only if the event name is
2026
- * <code>REPLICATION_STARTED</code> or <code>REPLICATION_STOPPED</code>.</p>
1737
+ * <p>ID of the session within the destination stage. Applicable only if the event name is <code>REPLICATION_STARTED</code> or <code>REPLICATION_STOPPED</code>.</p>
2027
1738
  * @public
2028
1739
  */
2029
1740
  destinationSessionId?: string | undefined;
2030
1741
  /**
2031
- * <p>If true, this indicates the <code>participantId</code> is a replicated participant.
2032
- * If this is a subscribe event, then this flag refers to <code>remoteParticipantId</code>. Default: <code>false</code>.</p>
1742
+ * <p>If true, this indicates the <code>participantId</code> is a replicated participant. If this is a subscribe event, then this flag refers to <code>remoteParticipantId</code>. Default: <code>false</code>.</p>
2033
1743
  * @public
2034
1744
  */
2035
1745
  replica?: boolean | undefined;
@@ -2054,8 +1764,7 @@ export interface ListParticipantEventsResponse {
2054
1764
  */
2055
1765
  events: Event[] | undefined;
2056
1766
  /**
2057
- * <p>If there are more events than <code>maxResults</code>, use <code>nextToken</code> in the
2058
- * request to get the next set. </p>
1767
+ * <p>If there are more events than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set. </p>
2059
1768
  * @public
2060
1769
  */
2061
1770
  nextToken?: string | undefined;
@@ -2070,9 +1779,7 @@ export interface ListParticipantReplicasRequest {
2070
1779
  */
2071
1780
  sourceStageArn: string | undefined;
2072
1781
  /**
2073
- * <p>Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by
2074
- * <a>CreateParticipantToken</a>
2075
- * or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed">create a self signed token</a>.</p>
1782
+ * <p>Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by <a>CreateParticipantToken</a> or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed">create a self signed token</a>.</p>
2076
1783
  * @public
2077
1784
  */
2078
1785
  participantId: string | undefined;
@@ -2098,10 +1805,7 @@ export interface ParticipantReplica {
2098
1805
  */
2099
1806
  sourceStageArn: string | undefined;
2100
1807
  /**
2101
- * <p>Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by
2102
- * <a>CreateParticipantToken</a>
2103
- * or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed">
2104
- * create a self signed token</a>.</p>
1808
+ * <p>Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by <a>CreateParticipantToken</a> or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed"> create a self signed token</a>.</p>
2105
1809
  * @public
2106
1810
  */
2107
1811
  participantId: string | undefined;
@@ -2156,32 +1860,22 @@ export interface ListParticipantsRequest {
2156
1860
  */
2157
1861
  sessionId: string | undefined;
2158
1862
  /**
2159
- * <p>Filters the response list to match the specified user ID.
2160
- * Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
2161
- * <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.
2162
- * A <code>userId</code> is a
2163
- * customer-assigned name to help identify the token; this can be used to link a participant
2164
- * to a user in the customer’s own systems.</p>
1863
+ * <p>Filters the response list to match the specified user ID. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request. A <code>userId</code> is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.</p>
2165
1864
  * @public
2166
1865
  */
2167
1866
  filterByUserId?: string | undefined;
2168
1867
  /**
2169
- * <p>Filters the response list to only show participants who published during the stage session.
2170
- * Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
2171
- * <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
1868
+ * <p>Filters the response list to only show participants who published during the stage session. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
2172
1869
  * @public
2173
1870
  */
2174
1871
  filterByPublished?: boolean | undefined;
2175
1872
  /**
2176
- * <p>Filters the response list to only show participants in the specified state.
2177
- * Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
2178
- * <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
1873
+ * <p>Filters the response list to only show participants in the specified state. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
2179
1874
  * @public
2180
1875
  */
2181
1876
  filterByState?: ParticipantState | undefined;
2182
1877
  /**
2183
- * <p>The first participant to retrieve. This is used for pagination; see the
2184
- * <code>nextToken</code> response field.</p>
1878
+ * <p>The first participant to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
2185
1879
  * @public
2186
1880
  */
2187
1881
  nextToken?: string | undefined;
@@ -2191,9 +1885,7 @@ export interface ListParticipantsRequest {
2191
1885
  */
2192
1886
  maxResults?: number | undefined;
2193
1887
  /**
2194
- * <p>Filters the response list to only show participants with the specified recording state.
2195
- * Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
2196
- * <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
1888
+ * <p>Filters the response list to only show participants with the specified recording state. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
2197
1889
  * @public
2198
1890
  */
2199
1891
  filterByRecordingState?: ParticipantRecordingFilterByRecordingState | undefined;
@@ -2209,10 +1901,7 @@ export interface ParticipantSummary {
2209
1901
  */
2210
1902
  participantId?: string | undefined;
2211
1903
  /**
2212
- * <p>Customer-assigned name to help identify the token; this can be used to link a
2213
- * participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
2214
- * <i>This field is exposed to all stage participants and should not be used for
2215
- * personally identifying, confidential, or sensitive information</i>.</p>
1904
+ * <p>Customer-assigned name to help identify the token; 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information</i>.</p>
2216
1905
  * @public
2217
1906
  */
2218
1907
  userId?: string | undefined;
@@ -2277,8 +1966,7 @@ export interface ListParticipantsResponse {
2277
1966
  */
2278
1967
  participants: ParticipantSummary[] | undefined;
2279
1968
  /**
2280
- * <p>If there are more participants than <code>maxResults</code>, use <code>nextToken</code>
2281
- * in the request to get the next set.</p>
1969
+ * <p>If there are more participants than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
2282
1970
  * @public
2283
1971
  */
2284
1972
  nextToken?: string | undefined;
@@ -2314,11 +2002,7 @@ export interface PublicKeySummary {
2314
2002
  */
2315
2003
  name?: string | undefined;
2316
2004
  /**
2317
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
2318
- * (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
2319
- * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2320
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2321
- * there.</p>
2005
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
2322
2006
  * @public
2323
2007
  */
2324
2008
  tags?: Record<string, string> | undefined;
@@ -2343,8 +2027,7 @@ export interface ListPublicKeysResponse {
2343
2027
  */
2344
2028
  export interface ListStagesRequest {
2345
2029
  /**
2346
- * <p>The first stage to retrieve. This is used for pagination; see the <code>nextToken</code>
2347
- * response field.</p>
2030
+ * <p>The first stage to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
2348
2031
  * @public
2349
2032
  */
2350
2033
  nextToken?: string | undefined;
@@ -2375,11 +2058,7 @@ export interface StageSummary {
2375
2058
  */
2376
2059
  activeSessionId?: string | undefined;
2377
2060
  /**
2378
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
2379
- * (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
2380
- * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2381
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2382
- * there.</p>
2061
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
2383
2062
  * @public
2384
2063
  */
2385
2064
  tags?: Record<string, string> | undefined;
@@ -2394,8 +2073,7 @@ export interface ListStagesResponse {
2394
2073
  */
2395
2074
  stages: StageSummary[] | undefined;
2396
2075
  /**
2397
- * <p>If there are more stages than <code>maxResults</code>, use <code>nextToken</code> in the
2398
- * request to get the next set.</p>
2076
+ * <p>If there are more stages than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
2399
2077
  * @public
2400
2078
  */
2401
2079
  nextToken?: string | undefined;
@@ -2410,8 +2088,7 @@ export interface ListStageSessionsRequest {
2410
2088
  */
2411
2089
  stageArn: string | undefined;
2412
2090
  /**
2413
- * <p>The first stage session to retrieve. This is used for pagination; see the
2414
- * <code>nextToken</code> response field.</p>
2091
+ * <p>The first stage session to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
2415
2092
  * @public
2416
2093
  */
2417
2094
  nextToken?: string | undefined;
@@ -2437,8 +2114,7 @@ export interface StageSessionSummary {
2437
2114
  */
2438
2115
  startTime?: Date | undefined;
2439
2116
  /**
2440
- * <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if
2441
- * the stage is active.</p>
2117
+ * <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.</p>
2442
2118
  * @public
2443
2119
  */
2444
2120
  endTime?: Date | undefined;
@@ -2453,8 +2129,7 @@ export interface ListStageSessionsResponse {
2453
2129
  */
2454
2130
  stageSessions: StageSessionSummary[] | undefined;
2455
2131
  /**
2456
- * <p>If there are more stage sessions than <code>maxResults</code>, use
2457
- * <code>nextToken</code> in the request to get the next set.</p>
2132
+ * <p>If there are more stage sessions than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
2458
2133
  * @public
2459
2134
  */
2460
2135
  nextToken?: string | undefined;
@@ -2464,14 +2139,12 @@ export interface ListStageSessionsResponse {
2464
2139
  */
2465
2140
  export interface ListStorageConfigurationsRequest {
2466
2141
  /**
2467
- * <p>The first storage configuration to retrieve. This is used for pagination;
2468
- * see the <code>nextToken</code> response field.</p>
2142
+ * <p>The first storage configuration to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
2469
2143
  * @public
2470
2144
  */
2471
2145
  nextToken?: string | undefined;
2472
2146
  /**
2473
- * <p>Maximum number of storage configurations to return. Default: your service quota or 100,
2474
- * whichever is smaller.</p>
2147
+ * <p>Maximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.</p>
2475
2148
  * @public
2476
2149
  */
2477
2150
  maxResults?: number | undefined;
@@ -2497,11 +2170,7 @@ export interface StorageConfigurationSummary {
2497
2170
  */
2498
2171
  s3?: S3StorageConfiguration | undefined;
2499
2172
  /**
2500
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
2501
- * (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
2502
- * Editor</i> for details, including restrictions that apply to tags and "Tag naming
2503
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2504
- * there.</p>
2173
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
2505
2174
  * @public
2506
2175
  */
2507
2176
  tags?: Record<string, string> | undefined;
@@ -2516,8 +2185,7 @@ export interface ListStorageConfigurationsResponse {
2516
2185
  */
2517
2186
  storageConfigurations: StorageConfigurationSummary[] | undefined;
2518
2187
  /**
2519
- * <p>If there are more storage configurations than <code>maxResults</code>, use <code>nextToken</code>
2520
- * in the request to get the next set.</p>
2188
+ * <p>If there are more storage configurations than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
2521
2189
  * @public
2522
2190
  */
2523
2191
  nextToken?: string | undefined;
@@ -2537,8 +2205,7 @@ export interface ListTagsForResourceRequest {
2537
2205
  */
2538
2206
  export interface ListTagsForResourceResponse {
2539
2207
  /**
2540
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
2541
- * (key:value)</code>.</p>
2208
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>.</p>
2542
2209
  * @public
2543
2210
  */
2544
2211
  tags: Record<string, string> | undefined;
@@ -2568,11 +2235,7 @@ export interface StartCompositionRequest {
2568
2235
  */
2569
2236
  destinations: DestinationConfiguration[] | undefined;
2570
2237
  /**
2571
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
2572
- * (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>
2573
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
2574
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2575
- * there.</p>
2238
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
2576
2239
  * @public
2577
2240
  */
2578
2241
  tags?: Record<string, string> | undefined;
@@ -2602,27 +2265,17 @@ export interface StartParticipantReplicationRequest {
2602
2265
  */
2603
2266
  destinationStageArn: string | undefined;
2604
2267
  /**
2605
- * <p>Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by
2606
- * <a>CreateParticipantToken</a>
2607
- * or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed">create a self signed token</a>.
2608
- * </p>
2268
+ * <p>Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by <a>CreateParticipantToken</a> or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed">create a self signed token</a>. </p>
2609
2269
  * @public
2610
2270
  */
2611
2271
  participantId: string | undefined;
2612
2272
  /**
2613
- * <p>If the participant disconnects and then reconnects within the specified interval, replication will continue to be <code>ACTIVE</code>.
2614
- * Default: 0.</p>
2273
+ * <p>If the participant disconnects and then reconnects within the specified interval, replication will continue to be <code>ACTIVE</code>. Default: 0.</p>
2615
2274
  * @public
2616
2275
  */
2617
2276
  reconnectWindowSeconds?: number | undefined;
2618
2277
  /**
2619
- * <p>Application-provided attributes to set on the replicated participant in the destination stage.
2620
- * Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
2621
- * <i>This field is exposed to all stage participants and should not be used for personally identifying,
2622
- * confidential, or sensitive information.</i>
2623
- * </p>
2624
- * <p>These attributes are merged with any attributes set for this participant when creating the token.
2625
- * If there is overlap in keys, the values in these attributes are replaced.</p>
2278
+ * <p>Application-provided attributes to set on the replicated participant in the destination stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p> <p>These attributes are merged with any attributes set for this participant when creating the token. If there is overlap in keys, the values in these attributes are replaced.</p>
2626
2279
  * @public
2627
2280
  */
2628
2281
  attributes?: Record<string, string> | undefined;
@@ -2697,10 +2350,7 @@ export interface StopParticipantReplicationRequest {
2697
2350
  */
2698
2351
  destinationStageArn: string | undefined;
2699
2352
  /**
2700
- * <p>Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by
2701
- * <a>CreateParticipantToken</a>
2702
- * or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed">
2703
- * create a self signed token</a>.</p>
2353
+ * <p>Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by <a>CreateParticipantToken</a> or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed"> create a self signed token</a>.</p>
2704
2354
  * @public
2705
2355
  */
2706
2356
  participantId: string | undefined;
@@ -2755,11 +2405,7 @@ export interface TagResourceRequest {
2755
2405
  */
2756
2406
  resourceArn: string | undefined;
2757
2407
  /**
2758
- * <p>Array of tags to be added or updated. Array of maps, each of the form
2759
- * <code>string:string (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>
2760
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
2761
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2762
- * there.</p>
2408
+ * <p>Array of tags to be added or updated. Array of maps, each of the form <code>string:string (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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
2763
2409
  * @public
2764
2410
  */
2765
2411
  tags: Record<string, string> | undefined;
@@ -2779,11 +2425,7 @@ export interface UntagResourceRequest {
2779
2425
  */
2780
2426
  resourceArn: string | undefined;
2781
2427
  /**
2782
- * <p>Array of tag keys (strings) for the tags to be removed.
2783
- * See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
2784
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
2785
- * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
2786
- * there.</p>
2428
+ * <p>Array of tag keys (strings) for the tags to be removed. 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 Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
2787
2429
  * @public
2788
2430
  */
2789
2431
  tagKeys: string[] | undefined;
@@ -2808,7 +2450,7 @@ export interface UpdateIngestConfigurationRequest {
2808
2450
  */
2809
2451
  stageArn?: string | undefined;
2810
2452
  /**
2811
- * <p>Indicates whether redundant ingest is enabled for the ingest configuration. Default: <code>false</code>.</p>
2453
+ * <p>Indicates whether redundant ingest is enabled for the ingest configuration. Default: <code>false</code>. </p>
2812
2454
  * @public
2813
2455
  */
2814
2456
  redundantIngest?: boolean | undefined;
@@ -2817,6 +2459,41 @@ export interface UpdateIngestConfigurationRequest {
2817
2459
  * @public
2818
2460
  */
2819
2461
  export interface UpdateIngestConfigurationResponse {
2462
+ /**
2463
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Access-Control-Allow-Origin">Access-Control-Allow-Origin</a> in the MDN Web Docs.</p>
2464
+ * @public
2465
+ */
2466
+ accessControlAllowOrigin?: string | undefined;
2467
+ /**
2468
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Access-Control-Expose-Headers">Access-Control-Expose-Headers</a> in the MDN Web Docs.</p>
2469
+ * @public
2470
+ */
2471
+ accessControlExposeHeaders?: string | undefined;
2472
+ /**
2473
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cache-Control">Cache-Control</a> in the MDN Web Docs.</p>
2474
+ * @public
2475
+ */
2476
+ cacheControl?: string | undefined;
2477
+ /**
2478
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Security-Policy">Content-Security-Policy</a> in the MDN Web Docs.</p>
2479
+ * @public
2480
+ */
2481
+ contentSecurityPolicy?: string | undefined;
2482
+ /**
2483
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Strict-Transport-Security">Strict-Transport-Security</a> in the MDN Web Docs.</p>
2484
+ * @public
2485
+ */
2486
+ strictTransportSecurity?: string | undefined;
2487
+ /**
2488
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/X-Content-Type-Options">X-Content-Type-Options</a> in the MDN Web Docs.</p>
2489
+ * @public
2490
+ */
2491
+ xContentTypeOptions?: string | undefined;
2492
+ /**
2493
+ * <p>See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/X-Frame-Options">X-Frame-Options</a> in the MDN Web Docs.</p>
2494
+ * @public
2495
+ */
2496
+ xFrameOptions?: string | undefined;
2820
2497
  /**
2821
2498
  * <p>The updated IngestConfiguration.</p>
2822
2499
  * @public