Skip to content

Commit 55553d6

Browse files
author
awstools
committed
feat(client-ivs-realtime): IVS Real-Time now offers customers the ability to broadcast to Stages using RTMP(S).
1 parent 833a3c3 commit 55553d6

23 files changed

+2281
-142
lines changed

clients/client-ivs-realtime/README.md

+45-5
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ participants.</p>
3737
<p>
3838
<b>Composition process</b> — Composites participants
3939
of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
40-
Composition endpoints support this process.</p>
40+
Composition operations support this process.</p>
4141
</li>
4242
<li>
4343
<p>
@@ -52,13 +52,13 @@ including how participants are positioned in the video.</p>
5252
<p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
5353
comprises a <i>key</i> and a <i>value</i>, both set by you. For
5454
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/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for more information, including restrictions that apply to
56-
tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific
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>
5858
<p>Tags can help you identify and organize your AWS resources. For example, you can use the
5959
same tag for different resources to indicate that they are related. You can also use tags to
6060
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 endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
61+
<p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and
6262
<a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
6363
<p>At most 50 tags can be applied to a resource.</p>
6464

@@ -264,6 +264,14 @@ CreateEncoderConfiguration
264264

265265
[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/)
266266

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+
267275
</details>
268276
<details>
269277
<summary>
@@ -296,6 +304,14 @@ DeleteEncoderConfiguration
296304

297305
[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/)
298306

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+
299315
</details>
300316
<details>
301317
<summary>
@@ -344,6 +360,14 @@ GetEncoderConfiguration
344360

345361
[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/)
346362

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+
347371
</details>
348372
<details>
349373
<summary>
@@ -408,6 +432,14 @@ ListEncoderConfigurations
408432

409433
[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/)
410434

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+
411443
</details>
412444
<details>
413445
<summary>
@@ -496,6 +528,14 @@ UntagResource
496528

497529
[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/)
498530

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+
499539
</details>
500540
<details>
501541
<summary>

clients/client-ivs-realtime/src/IVSRealTime.ts

+121-5
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ import {
77
CreateEncoderConfigurationCommandInput,
88
CreateEncoderConfigurationCommandOutput,
99
} from "./commands/CreateEncoderConfigurationCommand";
10+
import {
11+
CreateIngestConfigurationCommand,
12+
CreateIngestConfigurationCommandInput,
13+
CreateIngestConfigurationCommandOutput,
14+
} from "./commands/CreateIngestConfigurationCommand";
1015
import {
1116
CreateParticipantTokenCommand,
1217
CreateParticipantTokenCommandInput,
@@ -23,6 +28,11 @@ import {
2328
DeleteEncoderConfigurationCommandInput,
2429
DeleteEncoderConfigurationCommandOutput,
2530
} from "./commands/DeleteEncoderConfigurationCommand";
31+
import {
32+
DeleteIngestConfigurationCommand,
33+
DeleteIngestConfigurationCommandInput,
34+
DeleteIngestConfigurationCommandOutput,
35+
} from "./commands/DeleteIngestConfigurationCommand";
2636
import {
2737
DeletePublicKeyCommand,
2838
DeletePublicKeyCommandInput,
@@ -49,6 +59,11 @@ import {
4959
GetEncoderConfigurationCommandInput,
5060
GetEncoderConfigurationCommandOutput,
5161
} from "./commands/GetEncoderConfigurationCommand";
62+
import {
63+
GetIngestConfigurationCommand,
64+
GetIngestConfigurationCommandInput,
65+
GetIngestConfigurationCommandOutput,
66+
} from "./commands/GetIngestConfigurationCommand";
5267
import {
5368
GetParticipantCommand,
5469
GetParticipantCommandInput,
@@ -85,6 +100,11 @@ import {
85100
ListEncoderConfigurationsCommandInput,
86101
ListEncoderConfigurationsCommandOutput,
87102
} from "./commands/ListEncoderConfigurationsCommand";
103+
import {
104+
ListIngestConfigurationsCommand,
105+
ListIngestConfigurationsCommandInput,
106+
ListIngestConfigurationsCommandOutput,
107+
} from "./commands/ListIngestConfigurationsCommand";
88108
import {
89109
ListParticipantEventsCommand,
90110
ListParticipantEventsCommandInput,
@@ -132,21 +152,29 @@ import {
132152
UntagResourceCommandInput,
133153
UntagResourceCommandOutput,
134154
} from "./commands/UntagResourceCommand";
155+
import {
156+
UpdateIngestConfigurationCommand,
157+
UpdateIngestConfigurationCommandInput,
158+
UpdateIngestConfigurationCommandOutput,
159+
} from "./commands/UpdateIngestConfigurationCommand";
135160
import { UpdateStageCommand, UpdateStageCommandInput, UpdateStageCommandOutput } from "./commands/UpdateStageCommand";
136161
import { IVSRealTimeClient, IVSRealTimeClientConfig } from "./IVSRealTimeClient";
137162

138163
const commands = {
139164
CreateEncoderConfigurationCommand,
165+
CreateIngestConfigurationCommand,
140166
CreateParticipantTokenCommand,
141167
CreateStageCommand,
142168
CreateStorageConfigurationCommand,
143169
DeleteEncoderConfigurationCommand,
170+
DeleteIngestConfigurationCommand,
144171
DeletePublicKeyCommand,
145172
DeleteStageCommand,
146173
DeleteStorageConfigurationCommand,
147174
DisconnectParticipantCommand,
148175
GetCompositionCommand,
149176
GetEncoderConfigurationCommand,
177+
GetIngestConfigurationCommand,
150178
GetParticipantCommand,
151179
GetPublicKeyCommand,
152180
GetStageCommand,
@@ -155,6 +183,7 @@ const commands = {
155183
ImportPublicKeyCommand,
156184
ListCompositionsCommand,
157185
ListEncoderConfigurationsCommand,
186+
ListIngestConfigurationsCommand,
158187
ListParticipantEventsCommand,
159188
ListParticipantsCommand,
160189
ListPublicKeysCommand,
@@ -166,6 +195,7 @@ const commands = {
166195
StopCompositionCommand,
167196
TagResourceCommand,
168197
UntagResourceCommand,
198+
UpdateIngestConfigurationCommand,
169199
UpdateStageCommand,
170200
};
171201

@@ -188,6 +218,23 @@ export interface IVSRealTime {
188218
cb: (err: any, data?: CreateEncoderConfigurationCommandOutput) => void
189219
): void;
190220

221+
/**
222+
* @see {@link CreateIngestConfigurationCommand}
223+
*/
224+
createIngestConfiguration(
225+
args: CreateIngestConfigurationCommandInput,
226+
options?: __HttpHandlerOptions
227+
): Promise<CreateIngestConfigurationCommandOutput>;
228+
createIngestConfiguration(
229+
args: CreateIngestConfigurationCommandInput,
230+
cb: (err: any, data?: CreateIngestConfigurationCommandOutput) => void
231+
): void;
232+
createIngestConfiguration(
233+
args: CreateIngestConfigurationCommandInput,
234+
options: __HttpHandlerOptions,
235+
cb: (err: any, data?: CreateIngestConfigurationCommandOutput) => void
236+
): void;
237+
191238
/**
192239
* @see {@link CreateParticipantTokenCommand}
193240
*/
@@ -251,6 +298,23 @@ export interface IVSRealTime {
251298
cb: (err: any, data?: DeleteEncoderConfigurationCommandOutput) => void
252299
): void;
253300

301+
/**
302+
* @see {@link DeleteIngestConfigurationCommand}
303+
*/
304+
deleteIngestConfiguration(
305+
args: DeleteIngestConfigurationCommandInput,
306+
options?: __HttpHandlerOptions
307+
): Promise<DeleteIngestConfigurationCommandOutput>;
308+
deleteIngestConfiguration(
309+
args: DeleteIngestConfigurationCommandInput,
310+
cb: (err: any, data?: DeleteIngestConfigurationCommandOutput) => void
311+
): void;
312+
deleteIngestConfiguration(
313+
args: DeleteIngestConfigurationCommandInput,
314+
options: __HttpHandlerOptions,
315+
cb: (err: any, data?: DeleteIngestConfigurationCommandOutput) => void
316+
): void;
317+
254318
/**
255319
* @see {@link DeletePublicKeyCommand}
256320
*/
@@ -341,6 +405,23 @@ export interface IVSRealTime {
341405
cb: (err: any, data?: GetEncoderConfigurationCommandOutput) => void
342406
): void;
343407

408+
/**
409+
* @see {@link GetIngestConfigurationCommand}
410+
*/
411+
getIngestConfiguration(
412+
args: GetIngestConfigurationCommandInput,
413+
options?: __HttpHandlerOptions
414+
): Promise<GetIngestConfigurationCommandOutput>;
415+
getIngestConfiguration(
416+
args: GetIngestConfigurationCommandInput,
417+
cb: (err: any, data?: GetIngestConfigurationCommandOutput) => void
418+
): void;
419+
getIngestConfiguration(
420+
args: GetIngestConfigurationCommandInput,
421+
options: __HttpHandlerOptions,
422+
cb: (err: any, data?: GetIngestConfigurationCommandOutput) => void
423+
): void;
424+
344425
/**
345426
* @see {@link GetParticipantCommand}
346427
*/
@@ -458,6 +539,24 @@ export interface IVSRealTime {
458539
cb: (err: any, data?: ListEncoderConfigurationsCommandOutput) => void
459540
): void;
460541

542+
/**
543+
* @see {@link ListIngestConfigurationsCommand}
544+
*/
545+
listIngestConfigurations(): Promise<ListIngestConfigurationsCommandOutput>;
546+
listIngestConfigurations(
547+
args: ListIngestConfigurationsCommandInput,
548+
options?: __HttpHandlerOptions
549+
): Promise<ListIngestConfigurationsCommandOutput>;
550+
listIngestConfigurations(
551+
args: ListIngestConfigurationsCommandInput,
552+
cb: (err: any, data?: ListIngestConfigurationsCommandOutput) => void
553+
): void;
554+
listIngestConfigurations(
555+
args: ListIngestConfigurationsCommandInput,
556+
options: __HttpHandlerOptions,
557+
cb: (err: any, data?: ListIngestConfigurationsCommandOutput) => void
558+
): void;
559+
461560
/**
462561
* @see {@link ListParticipantEventsCommand}
463562
*/
@@ -624,6 +723,23 @@ export interface IVSRealTime {
624723
cb: (err: any, data?: UntagResourceCommandOutput) => void
625724
): void;
626725

726+
/**
727+
* @see {@link UpdateIngestConfigurationCommand}
728+
*/
729+
updateIngestConfiguration(
730+
args: UpdateIngestConfigurationCommandInput,
731+
options?: __HttpHandlerOptions
732+
): Promise<UpdateIngestConfigurationCommandOutput>;
733+
updateIngestConfiguration(
734+
args: UpdateIngestConfigurationCommandInput,
735+
cb: (err: any, data?: UpdateIngestConfigurationCommandOutput) => void
736+
): void;
737+
updateIngestConfiguration(
738+
args: UpdateIngestConfigurationCommandInput,
739+
options: __HttpHandlerOptions,
740+
cb: (err: any, data?: UpdateIngestConfigurationCommandOutput) => void
741+
): void;
742+
627743
/**
628744
* @see {@link UpdateStageCommand}
629745
*/
@@ -668,7 +784,7 @@ export interface IVSRealTime {
668784
* <p>
669785
* <b>Composition process</b> — Composites participants
670786
* of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
671-
* Composition endpoints support this process.</p>
787+
* Composition operations support this process.</p>
672788
* </li>
673789
* <li>
674790
* <p>
@@ -683,13 +799,13 @@ export interface IVSRealTime {
683799
* <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
684800
* comprises a <i>key</i> and a <i>value</i>, both set by you. For
685801
* example, you might set a tag as <code>topic:nature</code> to label a particular video
686-
* category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for more information, including restrictions that apply to
687-
* tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific
688-
* constraints beyond what is documented there.</p>
802+
* category. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
803+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
804+
* limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.</p>
689805
* <p>Tags can help you identify and organize your AWS resources. For example, you can use the
690806
* same tag for different resources to indicate that they are related. You can also use tags to
691807
* manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
692-
* <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
808+
* <p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and
693809
* <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
694810
* <p>At most 50 tags can be applied to a resource.</p>
695811
* @public

0 commit comments

Comments
 (0)