@aws-sdk/client-ivs-realtime 3.645.0 → 3.648.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -5
- package/dist-cjs/index.js +315 -2
- package/dist-es/IVSRealTime.js +10 -0
- package/dist-es/commands/CreateIngestConfigurationCommand.js +25 -0
- package/dist-es/commands/DeleteIngestConfigurationCommand.js +24 -0
- package/dist-es/commands/GetIngestConfigurationCommand.js +25 -0
- package/dist-es/commands/ListIngestConfigurationsCommand.js +24 -0
- package/dist-es/commands/UpdateIngestConfigurationCommand.js +25 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +44 -0
- package/dist-es/pagination/ListIngestConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +144 -0
- package/dist-types/IVSRealTime.d.ts +41 -5
- package/dist-types/IVSRealTimeClient.d.ts +12 -7
- package/dist-types/commands/CreateIngestConfigurationCommand.d.ts +97 -0
- package/dist-types/commands/CreateStageCommand.d.ts +2 -0
- package/dist-types/commands/DeleteIngestConfigurationCommand.d.ts +74 -0
- package/dist-types/commands/DeleteStageCommand.d.ts +3 -1
- package/dist-types/commands/DisconnectParticipantCommand.d.ts +3 -2
- package/dist-types/commands/GetIngestConfigurationCommand.d.ts +84 -0
- package/dist-types/commands/GetParticipantCommand.d.ts +1 -0
- package/dist-types/commands/GetStageCommand.d.ts +2 -0
- package/dist-types/commands/ListIngestConfigurationsCommand.d.ts +80 -0
- package/dist-types/commands/ListParticipantEventsCommand.d.ts +1 -1
- package/dist-types/commands/StartCompositionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIngestConfigurationCommand.d.ts +91 -0
- package/dist-types/commands/UpdateStageCommand.d.ts +2 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/index.d.ts +5 -5
- package/dist-types/models/models_0.d.ts +398 -60
- package/dist-types/pagination/ListIngestConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/ts3.4/IVSRealTime.d.ts +86 -0
- package/dist-types/ts3.4/IVSRealTimeClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateIngestConfigurationCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/DeleteIngestConfigurationCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/GetIngestConfigurationCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/ListIngestConfigurationsCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/UpdateIngestConfigurationCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +104 -0
- package/dist-types/ts3.4/pagination/ListIngestConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -37,7 +37,7 @@ participants.</p>
|
|
|
37
37
|
<p>
|
|
38
38
|
<b>Composition process</b> — Composites participants
|
|
39
39
|
of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
|
|
40
|
-
Composition
|
|
40
|
+
Composition operations support this process.</p>
|
|
41
41
|
</li>
|
|
42
42
|
<li>
|
|
43
43
|
<p>
|
|
@@ -52,13 +52,13 @@ including how participants are positioned in the video.</p>
|
|
|
52
52
|
<p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
|
|
53
53
|
comprises a <i>key</i> and a <i>value</i>, both set by you. For
|
|
54
54
|
example, you might set a tag as <code>topic:nature</code> to label a particular video
|
|
55
|
-
category. See <a href="https://docs.aws.amazon.com/
|
|
56
|
-
|
|
57
|
-
constraints beyond what is documented there.</p>
|
|
55
|
+
category. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
|
|
56
|
+
in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
57
|
+
limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.</p>
|
|
58
58
|
<p>Tags can help you identify and organize your AWS resources. For example, you can use the
|
|
59
59
|
same tag for different resources to indicate that they are related. You can also use tags to
|
|
60
60
|
manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
|
|
61
|
-
<p>The Amazon IVS real-time API has these tag-related
|
|
61
|
+
<p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and
|
|
62
62
|
<a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
|
|
63
63
|
<p>At most 50 tags can be applied to a resource.</p>
|
|
64
64
|
|
|
@@ -264,6 +264,14 @@ CreateEncoderConfiguration
|
|
|
264
264
|
|
|
265
265
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/CreateEncoderConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/CreateEncoderConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/CreateEncoderConfigurationCommandOutput/)
|
|
266
266
|
|
|
267
|
+
</details>
|
|
268
|
+
<details>
|
|
269
|
+
<summary>
|
|
270
|
+
CreateIngestConfiguration
|
|
271
|
+
</summary>
|
|
272
|
+
|
|
273
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/CreateIngestConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/CreateIngestConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/CreateIngestConfigurationCommandOutput/)
|
|
274
|
+
|
|
267
275
|
</details>
|
|
268
276
|
<details>
|
|
269
277
|
<summary>
|
|
@@ -296,6 +304,14 @@ DeleteEncoderConfiguration
|
|
|
296
304
|
|
|
297
305
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/DeleteEncoderConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/DeleteEncoderConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/DeleteEncoderConfigurationCommandOutput/)
|
|
298
306
|
|
|
307
|
+
</details>
|
|
308
|
+
<details>
|
|
309
|
+
<summary>
|
|
310
|
+
DeleteIngestConfiguration
|
|
311
|
+
</summary>
|
|
312
|
+
|
|
313
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/DeleteIngestConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/DeleteIngestConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/DeleteIngestConfigurationCommandOutput/)
|
|
314
|
+
|
|
299
315
|
</details>
|
|
300
316
|
<details>
|
|
301
317
|
<summary>
|
|
@@ -344,6 +360,14 @@ GetEncoderConfiguration
|
|
|
344
360
|
|
|
345
361
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/GetEncoderConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/GetEncoderConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/GetEncoderConfigurationCommandOutput/)
|
|
346
362
|
|
|
363
|
+
</details>
|
|
364
|
+
<details>
|
|
365
|
+
<summary>
|
|
366
|
+
GetIngestConfiguration
|
|
367
|
+
</summary>
|
|
368
|
+
|
|
369
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/GetIngestConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/GetIngestConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/GetIngestConfigurationCommandOutput/)
|
|
370
|
+
|
|
347
371
|
</details>
|
|
348
372
|
<details>
|
|
349
373
|
<summary>
|
|
@@ -408,6 +432,14 @@ ListEncoderConfigurations
|
|
|
408
432
|
|
|
409
433
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/ListEncoderConfigurationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/ListEncoderConfigurationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/ListEncoderConfigurationsCommandOutput/)
|
|
410
434
|
|
|
435
|
+
</details>
|
|
436
|
+
<details>
|
|
437
|
+
<summary>
|
|
438
|
+
ListIngestConfigurations
|
|
439
|
+
</summary>
|
|
440
|
+
|
|
441
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/ListIngestConfigurationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/ListIngestConfigurationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/ListIngestConfigurationsCommandOutput/)
|
|
442
|
+
|
|
411
443
|
</details>
|
|
412
444
|
<details>
|
|
413
445
|
<summary>
|
|
@@ -496,6 +528,14 @@ UntagResource
|
|
|
496
528
|
|
|
497
529
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/UntagResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/UntagResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/UntagResourceCommandOutput/)
|
|
498
530
|
|
|
531
|
+
</details>
|
|
532
|
+
<details>
|
|
533
|
+
<summary>
|
|
534
|
+
UpdateIngestConfiguration
|
|
535
|
+
</summary>
|
|
536
|
+
|
|
537
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/UpdateIngestConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/UpdateIngestConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/UpdateIngestConfigurationCommandOutput/)
|
|
538
|
+
|
|
499
539
|
</details>
|
|
500
540
|
<details>
|
|
501
541
|
<summary>
|