@aws-sdk/client-ivs-realtime 3.600.0 → 3.605.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 (41) hide show
  1. package/README.md +49 -170
  2. package/dist-cjs/index.js +230 -0
  3. package/dist-es/IVSRealTime.js +8 -0
  4. package/dist-es/commands/DeletePublicKeyCommand.js +24 -0
  5. package/dist-es/commands/GetPublicKeyCommand.js +24 -0
  6. package/dist-es/commands/ImportPublicKeyCommand.js +24 -0
  7. package/dist-es/commands/ListPublicKeysCommand.js +24 -0
  8. package/dist-es/commands/index.js +4 -0
  9. package/dist-es/models/models_0.js +19 -0
  10. package/dist-es/pagination/ListPublicKeysPaginator.js +4 -0
  11. package/dist-es/pagination/index.js +1 -0
  12. package/dist-es/protocols/Aws_restJson1.js +115 -0
  13. package/dist-types/IVSRealTime.d.ts +53 -177
  14. package/dist-types/IVSRealTimeClient.d.ts +30 -179
  15. package/dist-types/commands/CreateStageCommand.d.ts +16 -0
  16. package/dist-types/commands/DeletePublicKeyCommand.d.ts +75 -0
  17. package/dist-types/commands/GetParticipantCommand.d.ts +3 -0
  18. package/dist-types/commands/GetPublicKeyCommand.d.ts +77 -0
  19. package/dist-types/commands/GetStageCommand.d.ts +10 -0
  20. package/dist-types/commands/ImportPublicKeyCommand.d.ts +87 -0
  21. package/dist-types/commands/ListParticipantsCommand.d.ts +2 -0
  22. package/dist-types/commands/ListPublicKeysCommand.d.ts +76 -0
  23. package/dist-types/commands/UpdateStageCommand.d.ts +16 -0
  24. package/dist-types/commands/index.d.ts +4 -0
  25. package/dist-types/index.d.ts +24 -177
  26. package/dist-types/models/models_0.d.ts +305 -22
  27. package/dist-types/pagination/ListPublicKeysPaginator.d.ts +7 -0
  28. package/dist-types/pagination/index.d.ts +1 -0
  29. package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
  30. package/dist-types/ts3.4/IVSRealTime.d.ts +69 -0
  31. package/dist-types/ts3.4/IVSRealTimeClient.d.ts +24 -0
  32. package/dist-types/ts3.4/commands/DeletePublicKeyCommand.d.ts +39 -0
  33. package/dist-types/ts3.4/commands/GetPublicKeyCommand.d.ts +36 -0
  34. package/dist-types/ts3.4/commands/ImportPublicKeyCommand.d.ts +39 -0
  35. package/dist-types/ts3.4/commands/ListPublicKeysCommand.d.ts +39 -0
  36. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  37. package/dist-types/ts3.4/models/models_0.d.ts +80 -0
  38. package/dist-types/ts3.4/pagination/ListPublicKeysPaginator.d.ts +11 -0
  39. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  40. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
  41. package/package.json +1 -1
@@ -12,19 +12,23 @@ import { CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput
12
12
  import { CreateStageCommandInput, CreateStageCommandOutput } from "./commands/CreateStageCommand";
13
13
  import { CreateStorageConfigurationCommandInput, CreateStorageConfigurationCommandOutput } from "./commands/CreateStorageConfigurationCommand";
14
14
  import { DeleteEncoderConfigurationCommandInput, DeleteEncoderConfigurationCommandOutput } from "./commands/DeleteEncoderConfigurationCommand";
15
+ import { DeletePublicKeyCommandInput, DeletePublicKeyCommandOutput } from "./commands/DeletePublicKeyCommand";
15
16
  import { DeleteStageCommandInput, DeleteStageCommandOutput } from "./commands/DeleteStageCommand";
16
17
  import { DeleteStorageConfigurationCommandInput, DeleteStorageConfigurationCommandOutput } from "./commands/DeleteStorageConfigurationCommand";
17
18
  import { DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput } from "./commands/DisconnectParticipantCommand";
18
19
  import { GetCompositionCommandInput, GetCompositionCommandOutput } from "./commands/GetCompositionCommand";
19
20
  import { GetEncoderConfigurationCommandInput, GetEncoderConfigurationCommandOutput } from "./commands/GetEncoderConfigurationCommand";
20
21
  import { GetParticipantCommandInput, GetParticipantCommandOutput } from "./commands/GetParticipantCommand";
22
+ import { GetPublicKeyCommandInput, GetPublicKeyCommandOutput } from "./commands/GetPublicKeyCommand";
21
23
  import { GetStageCommandInput, GetStageCommandOutput } from "./commands/GetStageCommand";
22
24
  import { GetStageSessionCommandInput, GetStageSessionCommandOutput } from "./commands/GetStageSessionCommand";
23
25
  import { GetStorageConfigurationCommandInput, GetStorageConfigurationCommandOutput } from "./commands/GetStorageConfigurationCommand";
26
+ import { ImportPublicKeyCommandInput, ImportPublicKeyCommandOutput } from "./commands/ImportPublicKeyCommand";
24
27
  import { ListCompositionsCommandInput, ListCompositionsCommandOutput } from "./commands/ListCompositionsCommand";
25
28
  import { ListEncoderConfigurationsCommandInput, ListEncoderConfigurationsCommandOutput } from "./commands/ListEncoderConfigurationsCommand";
26
29
  import { ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput } from "./commands/ListParticipantEventsCommand";
27
30
  import { ListParticipantsCommandInput, ListParticipantsCommandOutput } from "./commands/ListParticipantsCommand";
31
+ import { ListPublicKeysCommandInput, ListPublicKeysCommandOutput } from "./commands/ListPublicKeysCommand";
28
32
  import { ListStagesCommandInput, ListStagesCommandOutput } from "./commands/ListStagesCommand";
29
33
  import { ListStageSessionsCommandInput, ListStageSessionsCommandOutput } from "./commands/ListStageSessionsCommand";
30
34
  import { ListStorageConfigurationsCommandInput, ListStorageConfigurationsCommandOutput } from "./commands/ListStorageConfigurationsCommand";
@@ -40,11 +44,11 @@ export { __Client };
40
44
  /**
41
45
  * @public
42
46
  */
43
- export type ServiceInputTypes = CreateEncoderConfigurationCommandInput | CreateParticipantTokenCommandInput | CreateStageCommandInput | CreateStorageConfigurationCommandInput | DeleteEncoderConfigurationCommandInput | DeleteStageCommandInput | DeleteStorageConfigurationCommandInput | DisconnectParticipantCommandInput | GetCompositionCommandInput | GetEncoderConfigurationCommandInput | GetParticipantCommandInput | GetStageCommandInput | GetStageSessionCommandInput | GetStorageConfigurationCommandInput | ListCompositionsCommandInput | ListEncoderConfigurationsCommandInput | ListParticipantEventsCommandInput | ListParticipantsCommandInput | ListStageSessionsCommandInput | ListStagesCommandInput | ListStorageConfigurationsCommandInput | ListTagsForResourceCommandInput | StartCompositionCommandInput | StopCompositionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateStageCommandInput;
47
+ export type ServiceInputTypes = CreateEncoderConfigurationCommandInput | CreateParticipantTokenCommandInput | CreateStageCommandInput | CreateStorageConfigurationCommandInput | DeleteEncoderConfigurationCommandInput | DeletePublicKeyCommandInput | DeleteStageCommandInput | DeleteStorageConfigurationCommandInput | DisconnectParticipantCommandInput | GetCompositionCommandInput | GetEncoderConfigurationCommandInput | GetParticipantCommandInput | GetPublicKeyCommandInput | GetStageCommandInput | GetStageSessionCommandInput | GetStorageConfigurationCommandInput | ImportPublicKeyCommandInput | ListCompositionsCommandInput | ListEncoderConfigurationsCommandInput | ListParticipantEventsCommandInput | ListParticipantsCommandInput | ListPublicKeysCommandInput | ListStageSessionsCommandInput | ListStagesCommandInput | ListStorageConfigurationsCommandInput | ListTagsForResourceCommandInput | StartCompositionCommandInput | StopCompositionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateStageCommandInput;
44
48
  /**
45
49
  * @public
46
50
  */
47
- export type ServiceOutputTypes = CreateEncoderConfigurationCommandOutput | CreateParticipantTokenCommandOutput | CreateStageCommandOutput | CreateStorageConfigurationCommandOutput | DeleteEncoderConfigurationCommandOutput | DeleteStageCommandOutput | DeleteStorageConfigurationCommandOutput | DisconnectParticipantCommandOutput | GetCompositionCommandOutput | GetEncoderConfigurationCommandOutput | GetParticipantCommandOutput | GetStageCommandOutput | GetStageSessionCommandOutput | GetStorageConfigurationCommandOutput | ListCompositionsCommandOutput | ListEncoderConfigurationsCommandOutput | ListParticipantEventsCommandOutput | ListParticipantsCommandOutput | ListStageSessionsCommandOutput | ListStagesCommandOutput | ListStorageConfigurationsCommandOutput | ListTagsForResourceCommandOutput | StartCompositionCommandOutput | StopCompositionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateStageCommandOutput;
51
+ export type ServiceOutputTypes = CreateEncoderConfigurationCommandOutput | CreateParticipantTokenCommandOutput | CreateStageCommandOutput | CreateStorageConfigurationCommandOutput | DeleteEncoderConfigurationCommandOutput | DeletePublicKeyCommandOutput | DeleteStageCommandOutput | DeleteStorageConfigurationCommandOutput | DisconnectParticipantCommandOutput | GetCompositionCommandOutput | GetEncoderConfigurationCommandOutput | GetParticipantCommandOutput | GetPublicKeyCommandOutput | GetStageCommandOutput | GetStageSessionCommandOutput | GetStorageConfigurationCommandOutput | ImportPublicKeyCommandOutput | ListCompositionsCommandOutput | ListEncoderConfigurationsCommandOutput | ListParticipantEventsCommandOutput | ListParticipantsCommandOutput | ListPublicKeysCommandOutput | ListStageSessionsCommandOutput | ListStagesCommandOutput | ListStorageConfigurationsCommandOutput | ListTagsForResourceCommandOutput | StartCompositionCommandOutput | StopCompositionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateStageCommandOutput;
48
52
  /**
49
53
  * @public
50
54
  */
@@ -178,48 +182,46 @@ export type IVSRealTimeClientResolvedConfigType = __SmithyResolvedConfiguration<
178
182
  export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolvedConfigType {
179
183
  }
180
184
  /**
181
- * <p>
182
- * <b>Introduction</b>
183
- * </p>
184
- * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
185
+ * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
185
186
  * API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
186
187
  * including errors.
187
188
  * </p>
188
- * <p>Terminology:</p>
189
+ * <p>
190
+ * <b>Key Concepts</b>
191
+ * </p>
189
192
  * <ul>
190
193
  * <li>
191
- * <p>A <i>stage</i> is a virtual space where participants can exchange video in real time.</p>
192
- * </li>
193
- * <li>
194
- * <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
195
- * </li>
196
- * <li>
197
- * <p>A <i>participant object</i> represents participants (people) in the stage and
198
- * contains information about them. When a token is created, it includes a participant ID;
199
- * when a participant uses that token to join a stage, the participant is associated with
200
- * that participant ID. There is a 1:1 mapping between participant tokens and
201
- * participants.</p>
194
+ * <p>
195
+ * <b>Stage</b> — A virtual space where participants can exchange video in real time.</p>
202
196
  * </li>
203
197
  * <li>
204
- * <p>Server-side composition: The <i>composition</i> process composites participants
205
- * of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
206
- * Composition endpoints support this process.</p>
198
+ * <p>
199
+ * <b>Participant token</b> A token that authenticates a participant when they join a stage.</p>
207
200
  * </li>
208
201
  * <li>
209
- * <p>Server-side composition: A <i>composition</i> controls the look of the outputs,
210
- * including how participants are positioned in the video.</p>
202
+ * <p>
203
+ * <b>Participant object</b> — Represents participants (people) in the stage and
204
+ * contains information about them. When a token is created, it includes a participant ID;
205
+ * when a participant uses that token to join a stage, the participant is associated with
206
+ * that participant ID. There is a 1:1 mapping between participant tokens and
207
+ * participants.</p>
211
208
  * </li>
212
209
  * </ul>
213
- * <p>
214
- * <b>Resources</b>
215
- * </p>
216
- * <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>
210
+ * <p>For server-side composition:</p>
217
211
  * <ul>
218
212
  * <li>
219
213
  * <p>
220
- * <b>Stage</b> — A stage is a virtual space where participants can exchange video in real time.</p>
214
+ * <b>Composition process</b> — Composites participants
215
+ * of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
216
+ * Composition endpoints support this process.</p>
217
+ * </li>
218
+ * <li>
219
+ * <p>
220
+ * <b>Composition</b> — Controls the look of the outputs,
221
+ * including how participants are positioned in the video.</p>
221
222
  * </li>
222
223
  * </ul>
224
+ * <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>
223
225
  * <p>
224
226
  * <b>Tagging</b>
225
227
  * </p>
@@ -235,157 +237,6 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
235
237
  * <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
236
238
  * <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
237
239
  * <p>At most 50 tags can be applied to a resource.</p>
238
- * <p>
239
- * <b>Stages Endpoints</b>
240
- * </p>
241
- * <ul>
242
- * <li>
243
- * <p>
244
- * <a>CreateParticipantToken</a> — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.</p>
245
- * </li>
246
- * <li>
247
- * <p>
248
- * <a>CreateStage</a> — Creates a new stage (and optionally participant tokens).</p>
249
- * </li>
250
- * <li>
251
- * <p>
252
- * <a>DeleteStage</a> — Shuts down and deletes the specified stage (disconnecting all participants).</p>
253
- * </li>
254
- * <li>
255
- * <p>
256
- * <a>DisconnectParticipant</a> — Disconnects a specified participant and revokes the participant permanently from a specified stage.</p>
257
- * </li>
258
- * <li>
259
- * <p>
260
- * <a>GetParticipant</a> — Gets information about the specified
261
- * participant token.</p>
262
- * </li>
263
- * <li>
264
- * <p>
265
- * <a>GetStage</a> — Gets information for the specified stage.</p>
266
- * </li>
267
- * <li>
268
- * <p>
269
- * <a>GetStageSession</a> — Gets information for the specified stage
270
- * session.</p>
271
- * </li>
272
- * <li>
273
- * <p>
274
- * <a>ListParticipantEvents</a> — Lists events for a specified
275
- * participant that occurred during a specified stage session.</p>
276
- * </li>
277
- * <li>
278
- * <p>
279
- * <a>ListParticipants</a> — Lists all participants in a specified stage
280
- * session.</p>
281
- * </li>
282
- * <li>
283
- * <p>
284
- * <a>ListStages</a> — Gets summary information about all stages in your account, in the AWS region where the API request is processed.</p>
285
- * </li>
286
- * <li>
287
- * <p>
288
- * <a>ListStageSessions</a> — Gets all sessions for a specified stage.</p>
289
- * </li>
290
- * <li>
291
- * <p>
292
- * <a>UpdateStage</a> — Updates a stage’s configuration.</p>
293
- * </li>
294
- * </ul>
295
- * <p>
296
- * <b>Composition Endpoints</b>
297
- * </p>
298
- * <ul>
299
- * <li>
300
- * <p>
301
- * <a>GetComposition</a> — Gets information about the specified
302
- * Composition resource.</p>
303
- * </li>
304
- * <li>
305
- * <p>
306
- * <a>ListCompositions</a> — Gets summary information about all
307
- * Compositions in your account, in the AWS region where the API request is processed.</p>
308
- * </li>
309
- * <li>
310
- * <p>
311
- * <a>StartComposition</a> — Starts a Composition from a stage based on
312
- * the configuration provided in the request.</p>
313
- * </li>
314
- * <li>
315
- * <p>
316
- * <a>StopComposition</a> — Stops and deletes a Composition resource.
317
- * Any broadcast from the Composition resource is stopped.</p>
318
- * </li>
319
- * </ul>
320
- * <p>
321
- * <b>EncoderConfiguration Endpoints</b>
322
- * </p>
323
- * <ul>
324
- * <li>
325
- * <p>
326
- * <a>CreateEncoderConfiguration</a> — Creates an EncoderConfiguration object.</p>
327
- * </li>
328
- * <li>
329
- * <p>
330
- * <a>DeleteEncoderConfiguration</a> — Deletes an EncoderConfiguration
331
- * resource. Ensures that no Compositions are using this template; otherwise, returns an
332
- * error.</p>
333
- * </li>
334
- * <li>
335
- * <p>
336
- * <a>GetEncoderConfiguration</a> — Gets information about the specified
337
- * EncoderConfiguration resource.</p>
338
- * </li>
339
- * <li>
340
- * <p>
341
- * <a>ListEncoderConfigurations</a> — Gets summary information about all
342
- * EncoderConfigurations in your account, in the AWS region where the API request is
343
- * processed.</p>
344
- * </li>
345
- * </ul>
346
- * <p>
347
- * <b>StorageConfiguration Endpoints</b>
348
- * </p>
349
- * <ul>
350
- * <li>
351
- * <p>
352
- * <a>CreateStorageConfiguration</a> — Creates a new storage configuration, used to enable
353
- * recording to Amazon S3.</p>
354
- * </li>
355
- * <li>
356
- * <p>
357
- * <a>DeleteStorageConfiguration</a> — Deletes the storage configuration for the specified ARN.</p>
358
- * </li>
359
- * <li>
360
- * <p>
361
- * <a>GetStorageConfiguration</a> — Gets the storage configuration for the specified ARN.</p>
362
- * </li>
363
- * <li>
364
- * <p>
365
- * <a>ListStorageConfigurations</a> — Gets summary information about all storage configurations in your
366
- * account, in the AWS region where the API request is processed.</p>
367
- * </li>
368
- * </ul>
369
- * <p>
370
- * <b>Tags Endpoints</b>
371
- * </p>
372
- * <ul>
373
- * <li>
374
- * <p>
375
- * <a>ListTagsForResource</a> — Gets information about AWS tags for the
376
- * specified ARN.</p>
377
- * </li>
378
- * <li>
379
- * <p>
380
- * <a>TagResource</a> — Adds or updates tags for the AWS resource with
381
- * the specified ARN.</p>
382
- * </li>
383
- * <li>
384
- * <p>
385
- * <a>UntagResource</a> — Removes tags from the resource with the
386
- * specified ARN.</p>
387
- * </li>
388
- * </ul>
389
240
  * @public
390
241
  */
391
242
  export declare class IVSRealTimeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IVSRealTimeClientResolvedConfig> {
@@ -51,6 +51,12 @@ declare const CreateStageCommand_base: {
51
51
  * tags: { // Tags
52
52
  * "<keys>": "STRING_VALUE",
53
53
  * },
54
+ * autoParticipantRecordingConfiguration: { // AutoParticipantRecordingConfiguration
55
+ * storageConfigurationArn: "STRING_VALUE", // required
56
+ * mediaTypes: [ // ParticipantRecordingMediaTypeList
57
+ * "STRING_VALUE",
58
+ * ],
59
+ * },
54
60
  * };
55
61
  * const command = new CreateStageCommand(input);
56
62
  * const response = await client.send(command);
@@ -62,6 +68,16 @@ declare const CreateStageCommand_base: {
62
68
  * // tags: { // Tags
63
69
  * // "<keys>": "STRING_VALUE",
64
70
  * // },
71
+ * // autoParticipantRecordingConfiguration: { // AutoParticipantRecordingConfiguration
72
+ * // storageConfigurationArn: "STRING_VALUE", // required
73
+ * // mediaTypes: [ // ParticipantRecordingMediaTypeList
74
+ * // "STRING_VALUE",
75
+ * // ],
76
+ * // },
77
+ * // endpoints: { // StageEndpoints
78
+ * // events: "STRING_VALUE",
79
+ * // whip: "STRING_VALUE",
80
+ * // },
65
81
  * // },
66
82
  * // participantTokens: [ // ParticipantTokenList
67
83
  * // { // ParticipantToken
@@ -0,0 +1,75 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
4
+ import { DeletePublicKeyRequest, DeletePublicKeyResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeletePublicKeyCommand}.
14
+ */
15
+ export interface DeletePublicKeyCommandInput extends DeletePublicKeyRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeletePublicKeyCommand}.
21
+ */
22
+ export interface DeletePublicKeyCommandOutput extends DeletePublicKeyResponse, __MetadataBearer {
23
+ }
24
+ declare const DeletePublicKeyCommand_base: {
25
+ new (input: DeletePublicKeyCommandInput): import("@smithy/smithy-client").CommandImpl<DeletePublicKeyCommandInput, DeletePublicKeyCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeletePublicKeyCommandInput): import("@smithy/smithy-client").CommandImpl<DeletePublicKeyCommandInput, DeletePublicKeyCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes the specified public key used to sign stage participant tokens.
31
+ * This invalidates future participant tokens generated using the key pair’s private key.
32
+ * </p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { IVSRealTimeClient, DeletePublicKeyCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
37
+ * // const { IVSRealTimeClient, DeletePublicKeyCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
38
+ * const client = new IVSRealTimeClient(config);
39
+ * const input = { // DeletePublicKeyRequest
40
+ * arn: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new DeletePublicKeyCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param DeletePublicKeyCommandInput - {@link DeletePublicKeyCommandInput}
49
+ * @returns {@link DeletePublicKeyCommandOutput}
50
+ * @see {@link DeletePublicKeyCommandInput} for command's `input` shape.
51
+ * @see {@link DeletePublicKeyCommandOutput} for command's `response` shape.
52
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
53
+ *
54
+ * @throws {@link AccessDeniedException} (client fault)
55
+ * <p/>
56
+ *
57
+ * @throws {@link ConflictException} (client fault)
58
+ * <p/>
59
+ *
60
+ * @throws {@link PendingVerification} (client fault)
61
+ * <p/>
62
+ *
63
+ * @throws {@link ResourceNotFoundException} (client fault)
64
+ * <p/>
65
+ *
66
+ * @throws {@link ValidationException} (client fault)
67
+ * <p/>
68
+ *
69
+ * @throws {@link IVSRealTimeServiceException}
70
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
71
+ *
72
+ * @public
73
+ */
74
+ export declare class DeletePublicKeyCommand extends DeletePublicKeyCommand_base {
75
+ }
@@ -57,6 +57,9 @@ declare const GetParticipantCommand_base: {
57
57
  * // browserName: "STRING_VALUE",
58
58
  * // browserVersion: "STRING_VALUE",
59
59
  * // sdkVersion: "STRING_VALUE",
60
+ * // recordingS3BucketName: "STRING_VALUE",
61
+ * // recordingS3Prefix: "STRING_VALUE",
62
+ * // recordingState: "STRING_VALUE",
60
63
  * // },
61
64
  * // };
62
65
  *
@@ -0,0 +1,77 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
4
+ import { GetPublicKeyRequest, GetPublicKeyResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetPublicKeyCommand}.
14
+ */
15
+ export interface GetPublicKeyCommandInput extends GetPublicKeyRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetPublicKeyCommand}.
21
+ */
22
+ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __MetadataBearer {
23
+ }
24
+ declare const GetPublicKeyCommand_base: {
25
+ new (input: GetPublicKeyCommandInput): import("@smithy/smithy-client").CommandImpl<GetPublicKeyCommandInput, GetPublicKeyCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetPublicKeyCommandInput): import("@smithy/smithy-client").CommandImpl<GetPublicKeyCommandInput, GetPublicKeyCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Gets information for the specified public key.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IVSRealTimeClient, GetPublicKeyCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
35
+ * // const { IVSRealTimeClient, GetPublicKeyCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
36
+ * const client = new IVSRealTimeClient(config);
37
+ * const input = { // GetPublicKeyRequest
38
+ * arn: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetPublicKeyCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetPublicKeyResponse
43
+ * // publicKey: { // PublicKey
44
+ * // arn: "STRING_VALUE",
45
+ * // name: "STRING_VALUE",
46
+ * // publicKeyMaterial: "STRING_VALUE",
47
+ * // fingerprint: "STRING_VALUE",
48
+ * // tags: { // Tags
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // },
52
+ * // };
53
+ *
54
+ * ```
55
+ *
56
+ * @param GetPublicKeyCommandInput - {@link GetPublicKeyCommandInput}
57
+ * @returns {@link GetPublicKeyCommandOutput}
58
+ * @see {@link GetPublicKeyCommandInput} for command's `input` shape.
59
+ * @see {@link GetPublicKeyCommandOutput} for command's `response` shape.
60
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
61
+ *
62
+ * @throws {@link AccessDeniedException} (client fault)
63
+ * <p/>
64
+ *
65
+ * @throws {@link ResourceNotFoundException} (client fault)
66
+ * <p/>
67
+ *
68
+ * @throws {@link ValidationException} (client fault)
69
+ * <p/>
70
+ *
71
+ * @throws {@link IVSRealTimeServiceException}
72
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
73
+ *
74
+ * @public
75
+ */
76
+ export declare class GetPublicKeyCommand extends GetPublicKeyCommand_base {
77
+ }
@@ -47,6 +47,16 @@ declare const GetStageCommand_base: {
47
47
  * // tags: { // Tags
48
48
  * // "<keys>": "STRING_VALUE",
49
49
  * // },
50
+ * // autoParticipantRecordingConfiguration: { // AutoParticipantRecordingConfiguration
51
+ * // storageConfigurationArn: "STRING_VALUE", // required
52
+ * // mediaTypes: [ // ParticipantRecordingMediaTypeList
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // },
56
+ * // endpoints: { // StageEndpoints
57
+ * // events: "STRING_VALUE",
58
+ * // whip: "STRING_VALUE",
59
+ * // },
50
60
  * // },
51
61
  * // };
52
62
  *
@@ -0,0 +1,87 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
4
+ import { ImportPublicKeyRequest, ImportPublicKeyResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ImportPublicKeyCommand}.
14
+ */
15
+ export interface ImportPublicKeyCommandInput extends ImportPublicKeyRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ImportPublicKeyCommand}.
21
+ */
22
+ export interface ImportPublicKeyCommandOutput extends ImportPublicKeyResponse, __MetadataBearer {
23
+ }
24
+ declare const ImportPublicKeyCommand_base: {
25
+ new (input: ImportPublicKeyCommandInput): import("@smithy/smithy-client").CommandImpl<ImportPublicKeyCommandInput, ImportPublicKeyCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ImportPublicKeyCommandInput): import("@smithy/smithy-client").CommandImpl<ImportPublicKeyCommandInput, ImportPublicKeyCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Import a public key to be used for signing stage participant tokens.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IVSRealTimeClient, ImportPublicKeyCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
35
+ * // const { IVSRealTimeClient, ImportPublicKeyCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
36
+ * const client = new IVSRealTimeClient(config);
37
+ * const input = { // ImportPublicKeyRequest
38
+ * publicKeyMaterial: "STRING_VALUE", // required
39
+ * name: "STRING_VALUE",
40
+ * tags: { // Tags
41
+ * "<keys>": "STRING_VALUE",
42
+ * },
43
+ * };
44
+ * const command = new ImportPublicKeyCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // ImportPublicKeyResponse
47
+ * // publicKey: { // PublicKey
48
+ * // arn: "STRING_VALUE",
49
+ * // name: "STRING_VALUE",
50
+ * // publicKeyMaterial: "STRING_VALUE",
51
+ * // fingerprint: "STRING_VALUE",
52
+ * // tags: { // Tags
53
+ * // "<keys>": "STRING_VALUE",
54
+ * // },
55
+ * // },
56
+ * // };
57
+ *
58
+ * ```
59
+ *
60
+ * @param ImportPublicKeyCommandInput - {@link ImportPublicKeyCommandInput}
61
+ * @returns {@link ImportPublicKeyCommandOutput}
62
+ * @see {@link ImportPublicKeyCommandInput} for command's `input` shape.
63
+ * @see {@link ImportPublicKeyCommandOutput} for command's `response` shape.
64
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
65
+ *
66
+ * @throws {@link AccessDeniedException} (client fault)
67
+ * <p/>
68
+ *
69
+ * @throws {@link ConflictException} (client fault)
70
+ * <p/>
71
+ *
72
+ * @throws {@link PendingVerification} (client fault)
73
+ * <p/>
74
+ *
75
+ * @throws {@link ServiceQuotaExceededException} (client fault)
76
+ * <p/>
77
+ *
78
+ * @throws {@link ValidationException} (client fault)
79
+ * <p/>
80
+ *
81
+ * @throws {@link IVSRealTimeServiceException}
82
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
83
+ *
84
+ * @public
85
+ */
86
+ export declare class ImportPublicKeyCommand extends ImportPublicKeyCommand_base {
87
+ }
@@ -42,6 +42,7 @@ declare const ListParticipantsCommand_base: {
42
42
  * filterByState: "STRING_VALUE",
43
43
  * nextToken: "STRING_VALUE",
44
44
  * maxResults: Number("int"),
45
+ * filterByRecordingState: "STRING_VALUE",
45
46
  * };
46
47
  * const command = new ListParticipantsCommand(input);
47
48
  * const response = await client.send(command);
@@ -53,6 +54,7 @@ declare const ListParticipantsCommand_base: {
53
54
  * // state: "STRING_VALUE",
54
55
  * // firstJoinTime: new Date("TIMESTAMP"),
55
56
  * // published: true || false,
57
+ * // recordingState: "STRING_VALUE",
56
58
  * // },
57
59
  * // ],
58
60
  * // nextToken: "STRING_VALUE",