Skip to content

Commit 3520f1a

Browse files
author
awstools
committed
feat(client-ivs-realtime): IVS Real-Time now offers customers the ability to upload public keys for customer vended participant tokens.
1 parent cdf4fe6 commit 3520f1a

17 files changed

+1493
-739
lines changed

Diff for: ‎clients/client-ivs-realtime/README.md

+49-170
Original file line numberDiff line numberDiff line change
@@ -6,48 +6,46 @@
66

77
AWS SDK for JavaScript IVSRealTime Client for Node.js, Browser and React Native.
88

9-
<p>
10-
<b>Introduction</b>
11-
</p>
129
<p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
1310
API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
1411
including errors.
1512
</p>
16-
<p>Terminology:</p>
13+
<p>
14+
<b>Key Concepts</b>
15+
</p>
1716
<ul>
1817
<li>
19-
<p>A <i>stage</i> is a virtual space where participants can exchange video in real time.</p>
18+
<p>
19+
<b>Stage</b> — A virtual space where participants can exchange video in real time.</p>
2020
</li>
2121
<li>
22-
<p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
22+
<p>
23+
<b>Participant token</b> — A token that authenticates a participant when they join a stage.</p>
2324
</li>
2425
<li>
25-
<p>A <i>participant object</i> represents participants (people) in the stage and
26+
<p>
27+
<b>Participant object</b> — Represents participants (people) in the stage and
2628
contains information about them. When a token is created, it includes a participant ID;
2729
when a participant uses that token to join a stage, the participant is associated with
2830
that participant ID. There is a 1:1 mapping between participant tokens and
2931
participants.</p>
3032
</li>
33+
</ul>
34+
<p>For server-side composition:</p>
35+
<ul>
3136
<li>
32-
<p>Server-side composition: The <i>composition</i> process composites participants
37+
<p>
38+
<b>Composition process</b> — Composites participants
3339
of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
3440
Composition endpoints support this process.</p>
3541
</li>
3642
<li>
37-
<p>Server-side composition: A <i>composition</i> controls the look of the outputs,
38-
including how participants are positioned in the video.</p>
39-
</li>
40-
</ul>
4143
<p>
42-
<b>Resources</b>
43-
</p>
44-
<p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>):</p>
45-
<ul>
46-
<li>
47-
<p>
48-
<b>Stage</b> — A stage is a virtual space where participants can exchange video in real time.</p>
44+
<b>Composition</b> — Controls the look of the outputs,
45+
including how participants are positioned in the video.</p>
4946
</li>
5047
</ul>
48+
<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>
5149
<p>
5250
<b>Tagging</b>
5351
</p>
@@ -63,157 +61,6 @@ manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/acc
6361
<p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
6462
<a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
6563
<p>At most 50 tags can be applied to a resource.</p>
66-
<p>
67-
<b>Stages Endpoints</b>
68-
</p>
69-
<ul>
70-
<li>
71-
<p>
72-
<a>CreateParticipantToken</a> — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.</p>
73-
</li>
74-
<li>
75-
<p>
76-
<a>CreateStage</a> — Creates a new stage (and optionally participant tokens).</p>
77-
</li>
78-
<li>
79-
<p>
80-
<a>DeleteStage</a> — Shuts down and deletes the specified stage (disconnecting all participants).</p>
81-
</li>
82-
<li>
83-
<p>
84-
<a>DisconnectParticipant</a> — Disconnects a specified participant and revokes the participant permanently from a specified stage.</p>
85-
</li>
86-
<li>
87-
<p>
88-
<a>GetParticipant</a> — Gets information about the specified
89-
participant token.</p>
90-
</li>
91-
<li>
92-
<p>
93-
<a>GetStage</a> — Gets information for the specified stage.</p>
94-
</li>
95-
<li>
96-
<p>
97-
<a>GetStageSession</a> — Gets information for the specified stage
98-
session.</p>
99-
</li>
100-
<li>
101-
<p>
102-
<a>ListParticipantEvents</a> — Lists events for a specified
103-
participant that occurred during a specified stage session.</p>
104-
</li>
105-
<li>
106-
<p>
107-
<a>ListParticipants</a> — Lists all participants in a specified stage
108-
session.</p>
109-
</li>
110-
<li>
111-
<p>
112-
<a>ListStages</a> — Gets summary information about all stages in your account, in the AWS region where the API request is processed.</p>
113-
</li>
114-
<li>
115-
<p>
116-
<a>ListStageSessions</a> — Gets all sessions for a specified stage.</p>
117-
</li>
118-
<li>
119-
<p>
120-
<a>UpdateStage</a> — Updates a stage’s configuration.</p>
121-
</li>
122-
</ul>
123-
<p>
124-
<b>Composition Endpoints</b>
125-
</p>
126-
<ul>
127-
<li>
128-
<p>
129-
<a>GetComposition</a> — Gets information about the specified
130-
Composition resource.</p>
131-
</li>
132-
<li>
133-
<p>
134-
<a>ListCompositions</a> — Gets summary information about all
135-
Compositions in your account, in the AWS region where the API request is processed.</p>
136-
</li>
137-
<li>
138-
<p>
139-
<a>StartComposition</a> — Starts a Composition from a stage based on
140-
the configuration provided in the request.</p>
141-
</li>
142-
<li>
143-
<p>
144-
<a>StopComposition</a> — Stops and deletes a Composition resource.
145-
Any broadcast from the Composition resource is stopped.</p>
146-
</li>
147-
</ul>
148-
<p>
149-
<b>EncoderConfiguration Endpoints</b>
150-
</p>
151-
<ul>
152-
<li>
153-
<p>
154-
<a>CreateEncoderConfiguration</a> — Creates an EncoderConfiguration object.</p>
155-
</li>
156-
<li>
157-
<p>
158-
<a>DeleteEncoderConfiguration</a> — Deletes an EncoderConfiguration
159-
resource. Ensures that no Compositions are using this template; otherwise, returns an
160-
error.</p>
161-
</li>
162-
<li>
163-
<p>
164-
<a>GetEncoderConfiguration</a> — Gets information about the specified
165-
EncoderConfiguration resource.</p>
166-
</li>
167-
<li>
168-
<p>
169-
<a>ListEncoderConfigurations</a> — Gets summary information about all
170-
EncoderConfigurations in your account, in the AWS region where the API request is
171-
processed.</p>
172-
</li>
173-
</ul>
174-
<p>
175-
<b>StorageConfiguration Endpoints</b>
176-
</p>
177-
<ul>
178-
<li>
179-
<p>
180-
<a>CreateStorageConfiguration</a> — Creates a new storage configuration, used to enable
181-
recording to Amazon S3.</p>
182-
</li>
183-
<li>
184-
<p>
185-
<a>DeleteStorageConfiguration</a> — Deletes the storage configuration for the specified ARN.</p>
186-
</li>
187-
<li>
188-
<p>
189-
<a>GetStorageConfiguration</a> — Gets the storage configuration for the specified ARN.</p>
190-
</li>
191-
<li>
192-
<p>
193-
<a>ListStorageConfigurations</a> — Gets summary information about all storage configurations in your
194-
account, in the AWS region where the API request is processed.</p>
195-
</li>
196-
</ul>
197-
<p>
198-
<b>Tags Endpoints</b>
199-
</p>
200-
<ul>
201-
<li>
202-
<p>
203-
<a>ListTagsForResource</a> — Gets information about AWS tags for the
204-
specified ARN.</p>
205-
</li>
206-
<li>
207-
<p>
208-
<a>TagResource</a> — Adds or updates tags for the AWS resource with
209-
the specified ARN.</p>
210-
</li>
211-
<li>
212-
<p>
213-
<a>UntagResource</a> — Removes tags from the resource with the
214-
specified ARN.</p>
215-
</li>
216-
</ul>
21764

21865
## Installing
21966

@@ -449,6 +296,14 @@ DeleteEncoderConfiguration
449296

450297
[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/)
451298

299+
</details>
300+
<details>
301+
<summary>
302+
DeletePublicKey
303+
</summary>
304+
305+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/DeletePublicKeyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/DeletePublicKeyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/DeletePublicKeyCommandOutput/)
306+
452307
</details>
453308
<details>
454309
<summary>
@@ -497,6 +352,14 @@ GetParticipant
497352

498353
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/GetParticipantCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/GetParticipantCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/GetParticipantCommandOutput/)
499354

355+
</details>
356+
<details>
357+
<summary>
358+
GetPublicKey
359+
</summary>
360+
361+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/GetPublicKeyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/GetPublicKeyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/GetPublicKeyCommandOutput/)
362+
500363
</details>
501364
<details>
502365
<summary>
@@ -521,6 +384,14 @@ GetStorageConfiguration
521384

522385
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/GetStorageConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/GetStorageConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/GetStorageConfigurationCommandOutput/)
523386

387+
</details>
388+
<details>
389+
<summary>
390+
ImportPublicKey
391+
</summary>
392+
393+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/ImportPublicKeyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/ImportPublicKeyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/ImportPublicKeyCommandOutput/)
394+
524395
</details>
525396
<details>
526397
<summary>
@@ -553,6 +424,14 @@ ListParticipants
553424

554425
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/ListParticipantsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/ListParticipantsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/ListParticipantsCommandOutput/)
555426

427+
</details>
428+
<details>
429+
<summary>
430+
ListPublicKeys
431+
</summary>
432+
433+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs-realtime/command/ListPublicKeysCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/ListPublicKeysCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs-realtime/Interface/ListPublicKeysCommandOutput/)
434+
556435
</details>
557436
<details>
558437
<summary>

0 commit comments

Comments
 (0)