@aws-sdk/client-ivs-realtime 3.1135.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
package/README.md CHANGED
@@ -6,84 +6,7 @@
6
6
 
7
7
  AWS SDK for JavaScript IVSRealTime Client for Node.js, Browser and React Native.
8
8
 
9
- <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
10
- API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
11
- including errors.
12
- </p>
13
- <p>
14
- <b>Key Concepts</b>
15
- </p>
16
- <ul>
17
- <li>
18
- <p>
19
- <b>Stage</b> — A virtual space where participants can exchange video in real time.</p>
20
- </li>
21
- <li>
22
- <p>
23
- <b>Participant token</b> — A token that authenticates a participant when they join a stage.</p>
24
- </li>
25
- <li>
26
- <p>
27
- <b>Participant object</b> — Represents participants (people) in the stage and
28
- contains information about them. When a token is created, it includes a participant ID;
29
- when a participant uses that token to join a stage, the participant is associated with
30
- that participant ID. There is a 1:1 mapping between participant tokens and
31
- participants.</p>
32
- </li>
33
- </ul>
34
- <p>For server-side composition:</p>
35
- <ul>
36
- <li>
37
- <p>
38
- <b>Composition process</b> — Composites participants
39
- of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
40
- Composition operations support this process.</p>
41
- </li>
42
- <li>
43
- <p>
44
- <b>Composition</b> — Controls the look of the outputs,
45
- including how participants are positioned in the video.</p>
46
- </li>
47
- </ul>
48
- <p>For participant replication:</p>
49
- <ul>
50
- <li>
51
- <p>
52
- <b>Source stage</b> — The stage where the participant originally joined, which is used as the source for
53
- replication.</p>
54
- </li>
55
- <li>
56
- <p>
57
- <b>Destination stage</b> — The stage to which the participant is replicated.
58
- </p>
59
- </li>
60
- <li>
61
- <p>
62
- <b>Replicated participant</b> — A participant in a stage that is replicated to one or more destination stages.
63
- </p>
64
- </li>
65
- <li>
66
- <p>
67
- <b>Replica participant</b> — A participant in a destination stage that is replicated from another stage
68
- (the source stage).</p>
69
- </li>
70
- </ul>
71
- <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>.</p>
72
- <p>
73
- <b>Tagging</b>
74
- </p>
75
- <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
76
- comprises a <i>key</i> and a <i>value</i>, both set by you. For
77
- example, you might set a tag as <code>topic:nature</code> to label a particular video
78
- category. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
79
- in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
80
- limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.</p>
81
- <p>Tags can help you identify and organize your AWS resources. For example, you can use the
82
- same tag for different resources to indicate that they are related. You can also use tags to
83
- manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
84
- <p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and
85
- <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
86
- <p>At most 50 tags can be applied to a resource.</p>
9
+ <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors. </p> <p> <b>Key Concepts</b> </p> <ul> <li> <p> <b>Stage</b> — A virtual space where participants can exchange video in real time.</p> </li> <li> <p> <b>Participant token</b> — A token that authenticates a participant when they join a stage.</p> </li> <li> <p> <b>Participant object</b> — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.</p> </li> </ul> <p>For server-side composition:</p> <ul> <li> <p> <b>Composition process</b> — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.</p> </li> <li> <p> <b>Composition</b> — Controls the look of the outputs, including how participants are positioned in the video.</p> </li> </ul> <p>For participant replication:</p> <ul> <li> <p> <b>Source stage</b> — The stage where the participant originally joined, which is used as the source for replication.</p> </li> <li> <p> <b>Destination stage</b> — The stage to which the participant is replicated. </p> </li> <li> <p> <b>Replicated participant</b> — A participant in a stage that is replicated to one or more destination stages. </p> </li> <li> <p> <b>Replica participant</b> — A participant in a destination stage that is replicated from another stage (the source stage).</p> </li> </ul> <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>.</p> <p> <b>Tagging</b> </p> <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag comprises a <i>key</i> and a <i>value</i>, both set by you. For example, you might set a tag as <code>topic:nature</code> to label a particular video category. 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 stages has no service-specific constraints beyond what is documented there.</p> <p>Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p> <p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p> <p>At most 50 tags can be applied to a resource.</p>
87
10
 
88
11
  ## Installing
89
12
 
package/dist-cjs/index.js CHANGED
@@ -69,7 +69,7 @@ const commonParams = {
69
69
  UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
70
70
  };
71
71
 
72
- var version = "3.1134.0";
72
+ var version = "3.1135.0";
73
73
  var packageInfo = {
74
74
  version: version};
75
75
 
@@ -790,8 +790,8 @@ var CreateIngestConfigurationRequest$ = [3, n0, _CICR,
790
790
  ];
791
791
  var CreateIngestConfigurationResponse$ = [3, n0, _CICRr,
792
792
  0,
793
- [_iC],
794
- [[() => IngestConfiguration$, 0]]
793
+ [_aCAO, _aCEH, _cC, _cSP, _sTS, _xCTO, _xFO, _iC],
794
+ [[0, { [_hH]: _ACAO }], [0, { [_hH]: _ACEH }], [0, { [_hH]: _CC }], [0, { [_hH]: _CSP }], [0, { [_hH]: _STS }], [0, { [_hH]: _XCTO }], [0, { [_hH]: _XFO }], [() => IngestConfiguration$, 0]]
795
795
  ];
796
796
  var CreateParticipantTokenRequest$ = [3, n0, _CPTR,
797
797
  0,
@@ -1320,8 +1320,8 @@ var UpdateIngestConfigurationRequest$ = [3, n0, _UICR,
1320
1320
  ];
1321
1321
  var UpdateIngestConfigurationResponse$ = [3, n0, _UICRp,
1322
1322
  0,
1323
- [_iC],
1324
- [[() => IngestConfiguration$, 0]]
1323
+ [_aCAO, _aCEH, _cC, _cSP, _sTS, _xCTO, _xFO, _iC],
1324
+ [[0, { [_hH]: _ACAO }], [0, { [_hH]: _ACEH }], [0, { [_hH]: _CC }], [0, { [_hH]: _CSP }], [0, { [_hH]: _STS }], [0, { [_hH]: _XCTO }], [0, { [_hH]: _XFO }], [() => IngestConfiguration$, 0]]
1325
1325
  ];
1326
1326
  var UpdateStageRequest$ = [3, n0, _USR,
1327
1327
  0,
@@ -442,8 +442,8 @@ export var CreateIngestConfigurationRequest$ = [3, n0, _CICR,
442
442
  ];
443
443
  export var CreateIngestConfigurationResponse$ = [3, n0, _CICRr,
444
444
  0,
445
- [_iC],
446
- [[() => IngestConfiguration$, 0]]
445
+ [_aCAO, _aCEH, _cC, _cSP, _sTS, _xCTO, _xFO, _iC],
446
+ [[0, { [_hH]: _ACAO }], [0, { [_hH]: _ACEH }], [0, { [_hH]: _CC }], [0, { [_hH]: _CSP }], [0, { [_hH]: _STS }], [0, { [_hH]: _XCTO }], [0, { [_hH]: _XFO }], [() => IngestConfiguration$, 0]]
447
447
  ];
448
448
  export var CreateParticipantTokenRequest$ = [3, n0, _CPTR,
449
449
  0,
@@ -972,8 +972,8 @@ export var UpdateIngestConfigurationRequest$ = [3, n0, _UICR,
972
972
  ];
973
973
  export var UpdateIngestConfigurationResponse$ = [3, n0, _UICRp,
974
974
  0,
975
- [_iC],
976
- [[() => IngestConfiguration$, 0]]
975
+ [_aCAO, _aCEH, _cC, _cSP, _sTS, _xCTO, _xFO, _iC],
976
+ [[0, { [_hH]: _ACAO }], [0, { [_hH]: _ACEH }], [0, { [_hH]: _CC }], [0, { [_hH]: _CSP }], [0, { [_hH]: _STS }], [0, { [_hH]: _XCTO }], [0, { [_hH]: _XFO }], [() => IngestConfiguration$, 0]]
977
977
  ];
978
978
  export var UpdateStageRequest$ = [3, n0, _USR,
979
979
  0,
@@ -354,84 +354,7 @@ export interface IVSRealTime {
354
354
  paginateListStorageConfigurations(args?: ListStorageConfigurationsCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListStorageConfigurationsCommandOutput>;
355
355
  }
356
356
  /**
357
- * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
358
- * API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
359
- * including errors.
360
- * </p>
361
- * <p>
362
- * <b>Key Concepts</b>
363
- * </p>
364
- * <ul>
365
- * <li>
366
- * <p>
367
- * <b>Stage</b> — A virtual space where participants can exchange video in real time.</p>
368
- * </li>
369
- * <li>
370
- * <p>
371
- * <b>Participant token</b> — A token that authenticates a participant when they join a stage.</p>
372
- * </li>
373
- * <li>
374
- * <p>
375
- * <b>Participant object</b> — Represents participants (people) in the stage and
376
- * contains information about them. When a token is created, it includes a participant ID;
377
- * when a participant uses that token to join a stage, the participant is associated with
378
- * that participant ID. There is a 1:1 mapping between participant tokens and
379
- * participants.</p>
380
- * </li>
381
- * </ul>
382
- * <p>For server-side composition:</p>
383
- * <ul>
384
- * <li>
385
- * <p>
386
- * <b>Composition process</b> — Composites participants
387
- * of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
388
- * Composition operations support this process.</p>
389
- * </li>
390
- * <li>
391
- * <p>
392
- * <b>Composition</b> — Controls the look of the outputs,
393
- * including how participants are positioned in the video.</p>
394
- * </li>
395
- * </ul>
396
- * <p>For participant replication:</p>
397
- * <ul>
398
- * <li>
399
- * <p>
400
- * <b>Source stage</b> — The stage where the participant originally joined, which is used as the source for
401
- * replication.</p>
402
- * </li>
403
- * <li>
404
- * <p>
405
- * <b>Destination stage</b> — The stage to which the participant is replicated.
406
- * </p>
407
- * </li>
408
- * <li>
409
- * <p>
410
- * <b>Replicated participant</b> — A participant in a stage that is replicated to one or more destination stages.
411
- * </p>
412
- * </li>
413
- * <li>
414
- * <p>
415
- * <b>Replica participant</b> — A participant in a destination stage that is replicated from another stage
416
- * (the source stage).</p>
417
- * </li>
418
- * </ul>
419
- * <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>.</p>
420
- * <p>
421
- * <b>Tagging</b>
422
- * </p>
423
- * <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
424
- * comprises a <i>key</i> and a <i>value</i>, both set by you. For
425
- * example, you might set a tag as <code>topic:nature</code> to label a particular video
426
- * category. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
427
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
428
- * limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.</p>
429
- * <p>Tags can help you identify and organize your AWS resources. For example, you can use the
430
- * same tag for different resources to indicate that they are related. You can also use tags to
431
- * manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
432
- * <p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and
433
- * <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
434
- * <p>At most 50 tags can be applied to a resource.</p>
357
+ * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors. </p> <p> <b>Key Concepts</b> </p> <ul> <li> <p> <b>Stage</b> — A virtual space where participants can exchange video in real time.</p> </li> <li> <p> <b>Participant token</b> — A token that authenticates a participant when they join a stage.</p> </li> <li> <p> <b>Participant object</b> — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.</p> </li> </ul> <p>For server-side composition:</p> <ul> <li> <p> <b>Composition process</b> — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.</p> </li> <li> <p> <b>Composition</b> — Controls the look of the outputs, including how participants are positioned in the video.</p> </li> </ul> <p>For participant replication:</p> <ul> <li> <p> <b>Source stage</b> — The stage where the participant originally joined, which is used as the source for replication.</p> </li> <li> <p> <b>Destination stage</b> — The stage to which the participant is replicated. </p> </li> <li> <p> <b>Replicated participant</b> — A participant in a stage that is replicated to one or more destination stages. </p> </li> <li> <p> <b>Replica participant</b> — A participant in a destination stage that is replicated from another stage (the source stage).</p> </li> </ul> <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>.</p> <p> <b>Tagging</b> </p> <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag comprises a <i>key</i> and a <i>value</i>, both set by you. For example, you might set a tag as <code>topic:nature</code> to label a particular video category. 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 stages has no service-specific constraints beyond what is documented there.</p> <p>Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p> <p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p> <p>At most 50 tags can be applied to a resource.</p>
435
358
  * @public
436
359
  */
437
360
  export declare class IVSRealTime extends IVSRealTimeClient implements IVSRealTime {
@@ -207,84 +207,7 @@ export type IVSRealTimeClientResolvedConfigType = __SmithyResolvedConfiguration<
207
207
  export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolvedConfigType {
208
208
  }
209
209
  /**
210
- * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
211
- * API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
212
- * including errors.
213
- * </p>
214
- * <p>
215
- * <b>Key Concepts</b>
216
- * </p>
217
- * <ul>
218
- * <li>
219
- * <p>
220
- * <b>Stage</b> — A virtual space where participants can exchange video in real time.</p>
221
- * </li>
222
- * <li>
223
- * <p>
224
- * <b>Participant token</b> — A token that authenticates a participant when they join a stage.</p>
225
- * </li>
226
- * <li>
227
- * <p>
228
- * <b>Participant object</b> — Represents participants (people) in the stage and
229
- * contains information about them. When a token is created, it includes a participant ID;
230
- * when a participant uses that token to join a stage, the participant is associated with
231
- * that participant ID. There is a 1:1 mapping between participant tokens and
232
- * participants.</p>
233
- * </li>
234
- * </ul>
235
- * <p>For server-side composition:</p>
236
- * <ul>
237
- * <li>
238
- * <p>
239
- * <b>Composition process</b> — Composites participants
240
- * of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
241
- * Composition operations support this process.</p>
242
- * </li>
243
- * <li>
244
- * <p>
245
- * <b>Composition</b> — Controls the look of the outputs,
246
- * including how participants are positioned in the video.</p>
247
- * </li>
248
- * </ul>
249
- * <p>For participant replication:</p>
250
- * <ul>
251
- * <li>
252
- * <p>
253
- * <b>Source stage</b> — The stage where the participant originally joined, which is used as the source for
254
- * replication.</p>
255
- * </li>
256
- * <li>
257
- * <p>
258
- * <b>Destination stage</b> — The stage to which the participant is replicated.
259
- * </p>
260
- * </li>
261
- * <li>
262
- * <p>
263
- * <b>Replicated participant</b> — A participant in a stage that is replicated to one or more destination stages.
264
- * </p>
265
- * </li>
266
- * <li>
267
- * <p>
268
- * <b>Replica participant</b> — A participant in a destination stage that is replicated from another stage
269
- * (the source stage).</p>
270
- * </li>
271
- * </ul>
272
- * <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>.</p>
273
- * <p>
274
- * <b>Tagging</b>
275
- * </p>
276
- * <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
277
- * comprises a <i>key</i> and a <i>value</i>, both set by you. For
278
- * example, you might set a tag as <code>topic:nature</code> to label a particular video
279
- * category. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
280
- * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
281
- * limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.</p>
282
- * <p>Tags can help you identify and organize your AWS resources. For example, you can use the
283
- * same tag for different resources to indicate that they are related. You can also use tags to
284
- * manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
285
- * <p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and
286
- * <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
287
- * <p>At most 50 tags can be applied to a resource.</p>
210
+ * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors. </p> <p> <b>Key Concepts</b> </p> <ul> <li> <p> <b>Stage</b> — A virtual space where participants can exchange video in real time.</p> </li> <li> <p> <b>Participant token</b> — A token that authenticates a participant when they join a stage.</p> </li> <li> <p> <b>Participant object</b> — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.</p> </li> </ul> <p>For server-side composition:</p> <ul> <li> <p> <b>Composition process</b> — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.</p> </li> <li> <p> <b>Composition</b> — Controls the look of the outputs, including how participants are positioned in the video.</p> </li> </ul> <p>For participant replication:</p> <ul> <li> <p> <b>Source stage</b> — The stage where the participant originally joined, which is used as the source for replication.</p> </li> <li> <p> <b>Destination stage</b> — The stage to which the participant is replicated. </p> </li> <li> <p> <b>Replicated participant</b> — A participant in a stage that is replicated to one or more destination stages. </p> </li> <li> <p> <b>Replica participant</b> — A participant in a destination stage that is replicated from another stage (the source stage).</p> </li> </ul> <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>.</p> <p> <b>Tagging</b> </p> <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag comprises a <i>key</i> and a <i>value</i>, both set by you. For example, you might set a tag as <code>topic:nature</code> to label a particular video category. 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 stages has no service-specific constraints beyond what is documented there.</p> <p>Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p> <p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p> <p>At most 50 tags can be applied to a resource.</p>
288
211
  * @public
289
212
  */
290
213
  export declare class IVSRealTimeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IVSRealTimeClientResolvedConfig> {
@@ -72,25 +72,25 @@ declare const CreateEncoderConfigurationCommand_base: {
72
72
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
73
73
  *
74
74
  * @throws {@link AccessDeniedException} (client fault)
75
- * <p/>
75
+ * <p>User does not have sufficient access to perform this action.</p>
76
76
  *
77
77
  * @throws {@link ConflictException} (client fault)
78
- * <p/>
78
+ * <p>Updating or deleting a resource can cause an inconsistent state.</p>
79
79
  *
80
80
  * @throws {@link InternalServerException} (server fault)
81
- * <p/>
81
+ * <p>Unexpected error during processing of request.</p>
82
82
  *
83
83
  * @throws {@link PendingVerification} (client fault)
84
- * <p/>
84
+ * <p>Your account is pending verification.</p>
85
85
  *
86
86
  * @throws {@link ResourceNotFoundException} (client fault)
87
- * <p/>
87
+ * <p>Request references a resource which does not exist.</p>
88
88
  *
89
89
  * @throws {@link ServiceQuotaExceededException} (client fault)
90
- * <p/>
90
+ * <p>Request would cause a service quota to be exceeded.</p>
91
91
  *
92
92
  * @throws {@link ValidationException} (client fault)
93
- * <p/>
93
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
94
94
  *
95
95
  * @throws {@link IVSRealTimeServiceException}
96
96
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
@@ -50,6 +50,13 @@ declare const CreateIngestConfigurationCommand_base: {
50
50
  * const command = new CreateIngestConfigurationCommand(input);
51
51
  * const response = await client.send(command);
52
52
  * // { // CreateIngestConfigurationResponse
53
+ * // accessControlAllowOrigin: "STRING_VALUE",
54
+ * // accessControlExposeHeaders: "STRING_VALUE",
55
+ * // cacheControl: "STRING_VALUE",
56
+ * // contentSecurityPolicy: "STRING_VALUE",
57
+ * // strictTransportSecurity: "STRING_VALUE",
58
+ * // xContentTypeOptions: "STRING_VALUE",
59
+ * // xFrameOptions: "STRING_VALUE",
53
60
  * // ingestConfiguration: { // IngestConfiguration
54
61
  * // name: "STRING_VALUE",
55
62
  * // arn: "STRING_VALUE", // required
@@ -84,16 +91,16 @@ declare const CreateIngestConfigurationCommand_base: {
84
91
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
85
92
  *
86
93
  * @throws {@link AccessDeniedException} (client fault)
87
- * <p/>
94
+ * <p>User does not have sufficient access to perform this action.</p>
88
95
  *
89
96
  * @throws {@link PendingVerification} (client fault)
90
- * <p/>
97
+ * <p>Your account is pending verification.</p>
91
98
  *
92
99
  * @throws {@link ServiceQuotaExceededException} (client fault)
93
- * <p/>
100
+ * <p>Request would cause a service quota to be exceeded.</p>
94
101
  *
95
102
  * @throws {@link ValidationException} (client fault)
96
- * <p/>
103
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
97
104
  *
98
105
  * @throws {@link IVSRealTimeServiceException}
99
106
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
@@ -24,11 +24,7 @@ declare const CreateParticipantTokenCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Creates an additional token for a specified stage. This can be done after stage creation
28
- * or when tokens expire. Tokens always are scoped to the stage for which they are
29
- * created.</p>
30
- * <p>Encryption keys are owned by Amazon IVS and never used directly by your
31
- * application.</p>
27
+ * <p>Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.</p> <p>Encryption keys are owned by Amazon IVS and never used directly by your application.</p>
32
28
  * @example
33
29
  * Use a bare-bones client and the command you need to make an API call.
34
30
  * ```javascript
@@ -75,19 +71,19 @@ declare const CreateParticipantTokenCommand_base: {
75
71
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
76
72
  *
77
73
  * @throws {@link AccessDeniedException} (client fault)
78
- * <p/>
74
+ * <p>User does not have sufficient access to perform this action.</p>
79
75
  *
80
76
  * @throws {@link PendingVerification} (client fault)
81
- * <p/>
77
+ * <p>Your account is pending verification.</p>
82
78
  *
83
79
  * @throws {@link ResourceNotFoundException} (client fault)
84
- * <p/>
80
+ * <p>Request references a resource which does not exist.</p>
85
81
  *
86
82
  * @throws {@link ServiceQuotaExceededException} (client fault)
87
- * <p/>
83
+ * <p>Request would cause a service quota to be exceeded.</p>
88
84
  *
89
85
  * @throws {@link ValidationException} (client fault)
90
- * <p/>
86
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
91
87
  *
92
88
  * @throws {@link IVSRealTimeServiceException}
93
89
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
@@ -130,16 +130,16 @@ declare const CreateStageCommand_base: {
130
130
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
131
131
  *
132
132
  * @throws {@link AccessDeniedException} (client fault)
133
- * <p/>
133
+ * <p>User does not have sufficient access to perform this action.</p>
134
134
  *
135
135
  * @throws {@link PendingVerification} (client fault)
136
- * <p/>
136
+ * <p>Your account is pending verification.</p>
137
137
  *
138
138
  * @throws {@link ServiceQuotaExceededException} (client fault)
139
- * <p/>
139
+ * <p>Request would cause a service quota to be exceeded.</p>
140
140
  *
141
141
  * @throws {@link ValidationException} (client fault)
142
- * <p/>
142
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
143
143
  *
144
144
  * @throws {@link IVSRealTimeServiceException}
145
145
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
@@ -24,9 +24,7 @@ declare const CreateStorageConfigurationCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Creates a new storage configuration, used to enable recording to Amazon S3.
28
- * When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket.
29
- * This will ensure that IVS has sufficient permissions to write content to the provided bucket.</p>
27
+ * <p>Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.</p>
30
28
  * @example
31
29
  * Use a bare-bones client and the command you need to make an API call.
32
30
  * ```javascript
@@ -68,25 +66,25 @@ declare const CreateStorageConfigurationCommand_base: {
68
66
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
69
67
  *
70
68
  * @throws {@link AccessDeniedException} (client fault)
71
- * <p/>
69
+ * <p>User does not have sufficient access to perform this action.</p>
72
70
  *
73
71
  * @throws {@link ConflictException} (client fault)
74
- * <p/>
72
+ * <p>Updating or deleting a resource can cause an inconsistent state.</p>
75
73
  *
76
74
  * @throws {@link InternalServerException} (server fault)
77
- * <p/>
75
+ * <p>Unexpected error during processing of request.</p>
78
76
  *
79
77
  * @throws {@link PendingVerification} (client fault)
80
- * <p/>
78
+ * <p>Your account is pending verification.</p>
81
79
  *
82
80
  * @throws {@link ResourceNotFoundException} (client fault)
83
- * <p/>
81
+ * <p>Request references a resource which does not exist.</p>
84
82
  *
85
83
  * @throws {@link ServiceQuotaExceededException} (client fault)
86
- * <p/>
84
+ * <p>Request would cause a service quota to be exceeded.</p>
87
85
  *
88
86
  * @throws {@link ValidationException} (client fault)
89
- * <p/>
87
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
90
88
  *
91
89
  * @throws {@link IVSRealTimeServiceException}
92
90
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
@@ -24,8 +24,7 @@ declare const DeleteEncoderConfigurationCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this
28
- * template; otherwise, returns an error.</p>
27
+ * <p>Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.</p>
29
28
  * @example
30
29
  * Use a bare-bones client and the command you need to make an API call.
31
30
  * ```javascript
@@ -50,22 +49,22 @@ declare const DeleteEncoderConfigurationCommand_base: {
50
49
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
51
50
  *
52
51
  * @throws {@link AccessDeniedException} (client fault)
53
- * <p/>
52
+ * <p>User does not have sufficient access to perform this action.</p>
54
53
  *
55
54
  * @throws {@link ConflictException} (client fault)
56
- * <p/>
55
+ * <p>Updating or deleting a resource can cause an inconsistent state.</p>
57
56
  *
58
57
  * @throws {@link InternalServerException} (server fault)
59
- * <p/>
58
+ * <p>Unexpected error during processing of request.</p>
60
59
  *
61
60
  * @throws {@link ResourceNotFoundException} (client fault)
62
- * <p/>
61
+ * <p>Request references a resource which does not exist.</p>
63
62
  *
64
63
  * @throws {@link ServiceQuotaExceededException} (client fault)
65
- * <p/>
64
+ * <p>Request would cause a service quota to be exceeded.</p>
66
65
  *
67
66
  * @throws {@link ValidationException} (client fault)
68
- * <p/>
67
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
69
68
  *
70
69
  * @throws {@link IVSRealTimeServiceException}
71
70
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
@@ -50,19 +50,19 @@ declare const DeleteIngestConfigurationCommand_base: {
50
50
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
51
51
  *
52
52
  * @throws {@link AccessDeniedException} (client fault)
53
- * <p/>
53
+ * <p>User does not have sufficient access to perform this action.</p>
54
54
  *
55
55
  * @throws {@link ConflictException} (client fault)
56
- * <p/>
56
+ * <p>Updating or deleting a resource can cause an inconsistent state.</p>
57
57
  *
58
58
  * @throws {@link PendingVerification} (client fault)
59
- * <p/>
59
+ * <p>Your account is pending verification.</p>
60
60
  *
61
61
  * @throws {@link ResourceNotFoundException} (client fault)
62
- * <p/>
62
+ * <p>Request references a resource which does not exist.</p>
63
63
  *
64
64
  * @throws {@link ValidationException} (client fault)
65
- * <p/>
65
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
66
66
  *
67
67
  * @throws {@link IVSRealTimeServiceException}
68
68
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
@@ -24,9 +24,7 @@ declare const DeletePublicKeyCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Deletes the specified public key used to sign stage participant tokens.
28
- * This invalidates future participant tokens generated using the key pair’s private key.
29
- * </p>
27
+ * <p>Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key. </p>
30
28
  * @example
31
29
  * Use a bare-bones client and the command you need to make an API call.
32
30
  * ```javascript
@@ -51,19 +49,19 @@ declare const DeletePublicKeyCommand_base: {
51
49
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
52
50
  *
53
51
  * @throws {@link AccessDeniedException} (client fault)
54
- * <p/>
52
+ * <p>User does not have sufficient access to perform this action.</p>
55
53
  *
56
54
  * @throws {@link ConflictException} (client fault)
57
- * <p/>
55
+ * <p>Updating or deleting a resource can cause an inconsistent state.</p>
58
56
  *
59
57
  * @throws {@link PendingVerification} (client fault)
60
- * <p/>
58
+ * <p>Your account is pending verification.</p>
61
59
  *
62
60
  * @throws {@link ResourceNotFoundException} (client fault)
63
- * <p/>
61
+ * <p>Request references a resource which does not exist.</p>
64
62
  *
65
63
  * @throws {@link ValidationException} (client fault)
66
- * <p/>
64
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
67
65
  *
68
66
  * @throws {@link IVSRealTimeServiceException}
69
67
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>