@aws-sdk/client-ivs-realtime 3.325.0 → 3.327.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 (11) hide show
  1. package/dist-types/commands/CreateParticipantTokenCommand.d.ts +18 -0
  2. package/dist-types/commands/CreateStageCommand.d.ts +28 -0
  3. package/dist-types/commands/DeleteStageCommand.d.ts +4 -0
  4. package/dist-types/commands/DisconnectParticipantCommand.d.ts +4 -0
  5. package/dist-types/commands/GetStageCommand.d.ts +13 -0
  6. package/dist-types/commands/ListStagesCommand.d.ts +16 -0
  7. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  8. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  9. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  10. package/dist-types/commands/UpdateStageCommand.d.ts +13 -0
  11. package/package.json +7 -7
package/dist-types/commands/CreateParticipantTokenCommand.d.ts CHANGED
@@ -41,6 +41,22 @@ export interface CreateParticipantTokenCommandOutput extends CreateParticipantTo
41
41
  * };
42
42
  * const command = new CreateParticipantTokenCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // CreateParticipantTokenResponse
45
+ * // participantToken: { // ParticipantToken
46
+ * // participantId: "STRING_VALUE",
47
+ * // token: "STRING_VALUE",
48
+ * // userId: "STRING_VALUE",
49
+ * // attributes: { // ParticipantTokenAttributes
50
+ * // "<keys>": "STRING_VALUE",
51
+ * // },
52
+ * // duration: Number("int"),
53
+ * // capabilities: [ // ParticipantTokenCapabilities
54
+ * // "STRING_VALUE",
55
+ * // ],
56
+ * // expirationTime: new Date("TIMESTAMP"),
57
+ * // },
58
+ * // };
59
+ *
44
60
  * ```
45
61
  *
46
62
  * @param CreateParticipantTokenCommandInput - {@link CreateParticipantTokenCommandInput}
@@ -64,6 +80,8 @@ export interface CreateParticipantTokenCommandOutput extends CreateParticipantTo
64
80
  * @throws {@link ValidationException} (client fault)
65
81
  * <p/>
66
82
  *
83
+ * @throws {@link IVSRealTimeServiceException}
84
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
67
85
  *
68
86
  */
69
87
  export declare class CreateParticipantTokenCommand extends $Command<CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput, IVSRealTimeClientResolvedConfig> {
package/dist-types/commands/CreateStageCommand.d.ts CHANGED
@@ -46,6 +46,32 @@ export interface CreateStageCommandOutput extends CreateStageResponse, __Metadat
46
46
  * };
47
47
  * const command = new CreateStageCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // CreateStageResponse
50
+ * // stage: { // Stage
51
+ * // arn: "STRING_VALUE", // required
52
+ * // name: "STRING_VALUE",
53
+ * // activeSessionId: "STRING_VALUE",
54
+ * // tags: { // Tags
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // },
58
+ * // participantTokens: [ // ParticipantTokenList
59
+ * // { // ParticipantToken
60
+ * // participantId: "STRING_VALUE",
61
+ * // token: "STRING_VALUE",
62
+ * // userId: "STRING_VALUE",
63
+ * // attributes: { // ParticipantTokenAttributes
64
+ * // "<keys>": "STRING_VALUE",
65
+ * // },
66
+ * // duration: Number("int"),
67
+ * // capabilities: [ // ParticipantTokenCapabilities
68
+ * // "STRING_VALUE",
69
+ * // ],
70
+ * // expirationTime: new Date("TIMESTAMP"),
71
+ * // },
72
+ * // ],
73
+ * // };
74
+ *
49
75
  * ```
50
76
  *
51
77
  * @param CreateStageCommandInput - {@link CreateStageCommandInput}
@@ -66,6 +92,8 @@ export interface CreateStageCommandOutput extends CreateStageResponse, __Metadat
66
92
  * @throws {@link ValidationException} (client fault)
67
93
  * <p/>
68
94
  *
95
+ * @throws {@link IVSRealTimeServiceException}
96
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
69
97
  *
70
98
  */
71
99
  export declare class CreateStageCommand extends $Command<CreateStageCommandInput, CreateStageCommandOutput, IVSRealTimeClientResolvedConfig> {
package/dist-types/commands/DeleteStageCommand.d.ts CHANGED
@@ -31,6 +31,8 @@ export interface DeleteStageCommandOutput extends DeleteStageResponse, __Metadat
31
31
  * };
32
32
  * const command = new DeleteStageCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteStageCommandInput - {@link DeleteStageCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteStageCommandOutput extends DeleteStageResponse, __Metadat
54
56
  * @throws {@link ValidationException} (client fault)
55
57
  * <p/>
56
58
  *
59
+ * @throws {@link IVSRealTimeServiceException}
60
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
57
61
  *
58
62
  */
59
63
  export declare class DeleteStageCommand extends $Command<DeleteStageCommandInput, DeleteStageCommandOutput, IVSRealTimeClientResolvedConfig> {
package/dist-types/commands/DisconnectParticipantCommand.d.ts CHANGED
@@ -33,6 +33,8 @@ export interface DisconnectParticipantCommandOutput extends DisconnectParticipan
33
33
  * };
34
34
  * const command = new DisconnectParticipantCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DisconnectParticipantCommandInput - {@link DisconnectParticipantCommandInput}
@@ -53,6 +55,8 @@ export interface DisconnectParticipantCommandOutput extends DisconnectParticipan
53
55
  * @throws {@link ValidationException} (client fault)
54
56
  * <p/>
55
57
  *
58
+ * @throws {@link IVSRealTimeServiceException}
59
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
56
60
  *
57
61
  */
58
62
  export declare class DisconnectParticipantCommand extends $Command<DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput, IVSRealTimeClientResolvedConfig> {
package/dist-types/commands/GetStageCommand.d.ts CHANGED
@@ -31,6 +31,17 @@ export interface GetStageCommandOutput extends GetStageResponse, __MetadataBeare
31
31
  * };
32
32
  * const command = new GetStageCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetStageResponse
35
+ * // stage: { // Stage
36
+ * // arn: "STRING_VALUE", // required
37
+ * // name: "STRING_VALUE",
38
+ * // activeSessionId: "STRING_VALUE",
39
+ * // tags: { // Tags
40
+ * // "<keys>": "STRING_VALUE",
41
+ * // },
42
+ * // },
43
+ * // };
44
+ *
34
45
  * ```
35
46
  *
36
47
  * @param GetStageCommandInput - {@link GetStageCommandInput}
@@ -48,6 +59,8 @@ export interface GetStageCommandOutput extends GetStageResponse, __MetadataBeare
48
59
  * @throws {@link ValidationException} (client fault)
49
60
  * <p/>
50
61
  *
62
+ * @throws {@link IVSRealTimeServiceException}
63
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
51
64
  *
52
65
  */
53
66
  export declare class GetStageCommand extends $Command<GetStageCommandInput, GetStageCommandOutput, IVSRealTimeClientResolvedConfig> {
package/dist-types/commands/ListStagesCommand.d.ts CHANGED
@@ -32,6 +32,20 @@ export interface ListStagesCommandOutput extends ListStagesResponse, __MetadataB
32
32
  * };
33
33
  * const command = new ListStagesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListStagesResponse
36
+ * // stages: [ // StageSummaryList // required
37
+ * // { // StageSummary
38
+ * // arn: "STRING_VALUE", // required
39
+ * // name: "STRING_VALUE",
40
+ * // activeSessionId: "STRING_VALUE",
41
+ * // tags: { // Tags
42
+ * // "<keys>": "STRING_VALUE",
43
+ * // },
44
+ * // },
45
+ * // ],
46
+ * // nextToken: "STRING_VALUE",
47
+ * // };
48
+ *
35
49
  * ```
36
50
  *
37
51
  * @param ListStagesCommandInput - {@link ListStagesCommandInput}
@@ -49,6 +63,8 @@ export interface ListStagesCommandOutput extends ListStagesResponse, __MetadataB
49
63
  * @throws {@link ValidationException} (client fault)
50
64
  * <p/>
51
65
  *
66
+ * @throws {@link IVSRealTimeServiceException}
67
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
52
68
  *
53
69
  */
54
70
  export declare class ListStagesCommand extends $Command<ListStagesCommandInput, ListStagesCommandOutput, IVSRealTimeClientResolvedConfig> {
package/dist-types/commands/ListTagsForResourceCommand.d.ts CHANGED
@@ -31,6 +31,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // tags: { // Tags // required
36
+ * // "<keys>": "STRING_VALUE",
37
+ * // },
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -48,6 +54,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
48
54
  * @throws {@link ValidationException} (client fault)
49
55
  * <p/>
50
56
  *
57
+ * @throws {@link IVSRealTimeServiceException}
58
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
51
59
  *
52
60
  */
53
61
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, IVSRealTimeClientResolvedConfig> {
package/dist-types/commands/TagResourceCommand.d.ts CHANGED
@@ -34,6 +34,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
34
34
  * };
35
35
  * const command = new TagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -51,6 +53,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
51
53
  * @throws {@link ValidationException} (client fault)
52
54
  * <p/>
53
55
  *
56
+ * @throws {@link IVSRealTimeServiceException}
57
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
54
58
  *
55
59
  */
56
60
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, IVSRealTimeClientResolvedConfig> {
package/dist-types/commands/UntagResourceCommand.d.ts CHANGED
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -51,6 +53,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
51
53
  * @throws {@link ValidationException} (client fault)
52
54
  * <p/>
53
55
  *
56
+ * @throws {@link IVSRealTimeServiceException}
57
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
54
58
  *
55
59
  */
56
60
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, IVSRealTimeClientResolvedConfig> {
package/dist-types/commands/UpdateStageCommand.d.ts CHANGED
@@ -32,6 +32,17 @@ export interface UpdateStageCommandOutput extends UpdateStageResponse, __Metadat
32
32
  * };
33
33
  * const command = new UpdateStageCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // UpdateStageResponse
36
+ * // stage: { // Stage
37
+ * // arn: "STRING_VALUE", // required
38
+ * // name: "STRING_VALUE",
39
+ * // activeSessionId: "STRING_VALUE",
40
+ * // tags: { // Tags
41
+ * // "<keys>": "STRING_VALUE",
42
+ * // },
43
+ * // },
44
+ * // };
45
+ *
35
46
  * ```
36
47
  *
37
48
  * @param UpdateStageCommandInput - {@link UpdateStageCommandInput}
@@ -55,6 +66,8 @@ export interface UpdateStageCommandOutput extends UpdateStageResponse, __Metadat
55
66
  * @throws {@link ValidationException} (client fault)
56
67
  * <p/>
57
68
  *
69
+ * @throws {@link IVSRealTimeServiceException}
70
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
58
71
  *
59
72
  */
60
73
  export declare class UpdateStageCommand extends $Command<UpdateStageCommandInput, UpdateStageCommandOutput, IVSRealTimeClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ivs-realtime",
3
3
  "description": "AWS SDK for JavaScript Ivs Realtime Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.327.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.327.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.327.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -32,11 +32,11 @@
32
32
  "@aws-sdk/middleware-host-header": "3.325.0",
33
33
  "@aws-sdk/middleware-logger": "3.325.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
- "@aws-sdk/middleware-retry": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.327.0",
36
36
  "@aws-sdk/middleware-serde": "3.325.0",
37
37
  "@aws-sdk/middleware-signing": "3.325.0",
38
38
  "@aws-sdk/middleware-stack": "3.325.0",
39
- "@aws-sdk/middleware-user-agent": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.327.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
@@ -48,8 +48,8 @@
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
49
  "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
50
  "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
- "@aws-sdk/util-endpoints": "3.319.0",
52
- "@aws-sdk/util-retry": "3.310.0",
51
+ "@aws-sdk/util-endpoints": "3.327.0",
52
+ "@aws-sdk/util-retry": "3.327.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",
55
55
  "@aws-sdk/util-utf8": "3.310.0",