@aws-sdk/client-ivs-realtime 3.451.0 → 3.454.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 +184 -5
- package/dist-cjs/IVSRealTime.js +24 -0
- package/dist-cjs/commands/CreateEncoderConfigurationCommand.js +51 -0
- package/dist-cjs/commands/CreateStorageConfigurationCommand.js +51 -0
- package/dist-cjs/commands/DeleteEncoderConfigurationCommand.js +51 -0
- package/dist-cjs/commands/DeleteStorageConfigurationCommand.js +51 -0
- package/dist-cjs/commands/GetCompositionCommand.js +51 -0
- package/dist-cjs/commands/GetEncoderConfigurationCommand.js +51 -0
- package/dist-cjs/commands/GetStorageConfigurationCommand.js +51 -0
- package/dist-cjs/commands/ListCompositionsCommand.js +51 -0
- package/dist-cjs/commands/ListEncoderConfigurationsCommand.js +51 -0
- package/dist-cjs/commands/ListStorageConfigurationsCommand.js +51 -0
- package/dist-cjs/commands/StartCompositionCommand.js +51 -0
- package/dist-cjs/commands/StopCompositionCommand.js +51 -0
- package/dist-cjs/commands/index.js +12 -0
- package/dist-cjs/models/models_0.js +51 -33
- package/dist-cjs/pagination/ListCompositionsPaginator.js +29 -0
- package/dist-cjs/pagination/ListEncoderConfigurationsPaginator.js +29 -0
- package/dist-cjs/pagination/ListStorageConfigurationsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1036 -101
- package/dist-es/IVSRealTime.js +24 -0
- package/dist-es/commands/CreateEncoderConfigurationCommand.js +47 -0
- package/dist-es/commands/CreateStorageConfigurationCommand.js +47 -0
- package/dist-es/commands/DeleteEncoderConfigurationCommand.js +47 -0
- package/dist-es/commands/DeleteStorageConfigurationCommand.js +47 -0
- package/dist-es/commands/GetCompositionCommand.js +47 -0
- package/dist-es/commands/GetEncoderConfigurationCommand.js +47 -0
- package/dist-es/commands/GetStorageConfigurationCommand.js +47 -0
- package/dist-es/commands/ListCompositionsCommand.js +47 -0
- package/dist-es/commands/ListEncoderConfigurationsCommand.js +47 -0
- package/dist-es/commands/ListStorageConfigurationsCommand.js +47 -0
- package/dist-es/commands/StartCompositionCommand.js +47 -0
- package/dist-es/commands/StopCompositionCommand.js +47 -0
- package/dist-es/commands/index.js +12 -0
- package/dist-es/models/models_0.js +48 -30
- package/dist-es/pagination/ListCompositionsPaginator.js +25 -0
- package/dist-es/pagination/ListEncoderConfigurationsPaginator.js +25 -0
- package/dist-es/pagination/ListStorageConfigurationsPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +1002 -92
- package/dist-types/IVSRealTime.d.ts +172 -5
- package/dist-types/IVSRealTimeClient.d.ts +102 -7
- package/dist-types/commands/CreateEncoderConfigurationCommand.d.ts +115 -0
- package/dist-types/commands/CreateStorageConfigurationCommand.d.ts +111 -0
- package/dist-types/commands/DeleteEncoderConfigurationCommand.d.ts +90 -0
- package/dist-types/commands/DeleteStorageConfigurationCommand.d.ts +92 -0
- package/dist-types/commands/GetCompositionCommand.d.ts +134 -0
- package/dist-types/commands/GetEncoderConfigurationCommand.d.ts +103 -0
- package/dist-types/commands/GetStorageConfigurationCommand.d.ts +100 -0
- package/dist-types/commands/ListCompositionsCommand.d.ts +112 -0
- package/dist-types/commands/ListEncoderConfigurationsCommand.d.ts +99 -0
- package/dist-types/commands/ListStorageConfigurationsCommand.d.ts +102 -0
- package/dist-types/commands/StartCompositionCommand.d.ts +187 -0
- package/dist-types/commands/StopCompositionCommand.d.ts +90 -0
- package/dist-types/commands/index.d.ts +12 -0
- package/dist-types/index.d.ts +88 -5
- package/dist-types/models/models_0.d.ts +908 -92
- package/dist-types/pagination/ListCompositionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEncoderConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListStorageConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +108 -0
- package/dist-types/ts3.4/IVSRealTime.d.ts +204 -0
- package/dist-types/ts3.4/IVSRealTimeClient.d.ts +72 -0
- package/dist-types/ts3.4/commands/CreateEncoderConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateStorageConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteEncoderConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteStorageConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetCompositionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetEncoderConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetStorageConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListCompositionsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListEncoderConfigurationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListStorageConfigurationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartCompositionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StopCompositionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +12 -0
- package/dist-types/ts3.4/models/models_0.d.ts +234 -34
- package/dist-types/ts3.4/pagination/ListCompositionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEncoderConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListStorageConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +144 -0
- package/package.json +5 -3
|
@@ -1,21 +1,39 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
|
|
2
|
+
import { CreateEncoderConfigurationCommandInput, CreateEncoderConfigurationCommandOutput } from "./commands/CreateEncoderConfigurationCommand";
|
|
2
3
|
import { CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput } from "./commands/CreateParticipantTokenCommand";
|
|
3
4
|
import { CreateStageCommandInput, CreateStageCommandOutput } from "./commands/CreateStageCommand";
|
|
5
|
+
import { CreateStorageConfigurationCommandInput, CreateStorageConfigurationCommandOutput } from "./commands/CreateStorageConfigurationCommand";
|
|
6
|
+
import { DeleteEncoderConfigurationCommandInput, DeleteEncoderConfigurationCommandOutput } from "./commands/DeleteEncoderConfigurationCommand";
|
|
4
7
|
import { DeleteStageCommandInput, DeleteStageCommandOutput } from "./commands/DeleteStageCommand";
|
|
8
|
+
import { DeleteStorageConfigurationCommandInput, DeleteStorageConfigurationCommandOutput } from "./commands/DeleteStorageConfigurationCommand";
|
|
5
9
|
import { DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput } from "./commands/DisconnectParticipantCommand";
|
|
10
|
+
import { GetCompositionCommandInput, GetCompositionCommandOutput } from "./commands/GetCompositionCommand";
|
|
11
|
+
import { GetEncoderConfigurationCommandInput, GetEncoderConfigurationCommandOutput } from "./commands/GetEncoderConfigurationCommand";
|
|
6
12
|
import { GetParticipantCommandInput, GetParticipantCommandOutput } from "./commands/GetParticipantCommand";
|
|
7
13
|
import { GetStageCommandInput, GetStageCommandOutput } from "./commands/GetStageCommand";
|
|
8
14
|
import { GetStageSessionCommandInput, GetStageSessionCommandOutput } from "./commands/GetStageSessionCommand";
|
|
15
|
+
import { GetStorageConfigurationCommandInput, GetStorageConfigurationCommandOutput } from "./commands/GetStorageConfigurationCommand";
|
|
16
|
+
import { ListCompositionsCommandInput, ListCompositionsCommandOutput } from "./commands/ListCompositionsCommand";
|
|
17
|
+
import { ListEncoderConfigurationsCommandInput, ListEncoderConfigurationsCommandOutput } from "./commands/ListEncoderConfigurationsCommand";
|
|
9
18
|
import { ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput } from "./commands/ListParticipantEventsCommand";
|
|
10
19
|
import { ListParticipantsCommandInput, ListParticipantsCommandOutput } from "./commands/ListParticipantsCommand";
|
|
11
20
|
import { ListStagesCommandInput, ListStagesCommandOutput } from "./commands/ListStagesCommand";
|
|
12
21
|
import { ListStageSessionsCommandInput, ListStageSessionsCommandOutput } from "./commands/ListStageSessionsCommand";
|
|
22
|
+
import { ListStorageConfigurationsCommandInput, ListStorageConfigurationsCommandOutput } from "./commands/ListStorageConfigurationsCommand";
|
|
13
23
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
24
|
+
import { StartCompositionCommandInput, StartCompositionCommandOutput } from "./commands/StartCompositionCommand";
|
|
25
|
+
import { StopCompositionCommandInput, StopCompositionCommandOutput } from "./commands/StopCompositionCommand";
|
|
14
26
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
15
27
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
16
28
|
import { UpdateStageCommandInput, UpdateStageCommandOutput } from "./commands/UpdateStageCommand";
|
|
17
29
|
import { IVSRealTimeClient } from "./IVSRealTimeClient";
|
|
18
30
|
export interface IVSRealTime {
|
|
31
|
+
/**
|
|
32
|
+
* @see {@link CreateEncoderConfigurationCommand}
|
|
33
|
+
*/
|
|
34
|
+
createEncoderConfiguration(args: CreateEncoderConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateEncoderConfigurationCommandOutput>;
|
|
35
|
+
createEncoderConfiguration(args: CreateEncoderConfigurationCommandInput, cb: (err: any, data?: CreateEncoderConfigurationCommandOutput) => void): void;
|
|
36
|
+
createEncoderConfiguration(args: CreateEncoderConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEncoderConfigurationCommandOutput) => void): void;
|
|
19
37
|
/**
|
|
20
38
|
* @see {@link CreateParticipantTokenCommand}
|
|
21
39
|
*/
|
|
@@ -28,18 +46,48 @@ export interface IVSRealTime {
|
|
|
28
46
|
createStage(args: CreateStageCommandInput, options?: __HttpHandlerOptions): Promise<CreateStageCommandOutput>;
|
|
29
47
|
createStage(args: CreateStageCommandInput, cb: (err: any, data?: CreateStageCommandOutput) => void): void;
|
|
30
48
|
createStage(args: CreateStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStageCommandOutput) => void): void;
|
|
49
|
+
/**
|
|
50
|
+
* @see {@link CreateStorageConfigurationCommand}
|
|
51
|
+
*/
|
|
52
|
+
createStorageConfiguration(args: CreateStorageConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateStorageConfigurationCommandOutput>;
|
|
53
|
+
createStorageConfiguration(args: CreateStorageConfigurationCommandInput, cb: (err: any, data?: CreateStorageConfigurationCommandOutput) => void): void;
|
|
54
|
+
createStorageConfiguration(args: CreateStorageConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStorageConfigurationCommandOutput) => void): void;
|
|
55
|
+
/**
|
|
56
|
+
* @see {@link DeleteEncoderConfigurationCommand}
|
|
57
|
+
*/
|
|
58
|
+
deleteEncoderConfiguration(args: DeleteEncoderConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEncoderConfigurationCommandOutput>;
|
|
59
|
+
deleteEncoderConfiguration(args: DeleteEncoderConfigurationCommandInput, cb: (err: any, data?: DeleteEncoderConfigurationCommandOutput) => void): void;
|
|
60
|
+
deleteEncoderConfiguration(args: DeleteEncoderConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEncoderConfigurationCommandOutput) => void): void;
|
|
31
61
|
/**
|
|
32
62
|
* @see {@link DeleteStageCommand}
|
|
33
63
|
*/
|
|
34
64
|
deleteStage(args: DeleteStageCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStageCommandOutput>;
|
|
35
65
|
deleteStage(args: DeleteStageCommandInput, cb: (err: any, data?: DeleteStageCommandOutput) => void): void;
|
|
36
66
|
deleteStage(args: DeleteStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStageCommandOutput) => void): void;
|
|
67
|
+
/**
|
|
68
|
+
* @see {@link DeleteStorageConfigurationCommand}
|
|
69
|
+
*/
|
|
70
|
+
deleteStorageConfiguration(args: DeleteStorageConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStorageConfigurationCommandOutput>;
|
|
71
|
+
deleteStorageConfiguration(args: DeleteStorageConfigurationCommandInput, cb: (err: any, data?: DeleteStorageConfigurationCommandOutput) => void): void;
|
|
72
|
+
deleteStorageConfiguration(args: DeleteStorageConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStorageConfigurationCommandOutput) => void): void;
|
|
37
73
|
/**
|
|
38
74
|
* @see {@link DisconnectParticipantCommand}
|
|
39
75
|
*/
|
|
40
76
|
disconnectParticipant(args: DisconnectParticipantCommandInput, options?: __HttpHandlerOptions): Promise<DisconnectParticipantCommandOutput>;
|
|
41
77
|
disconnectParticipant(args: DisconnectParticipantCommandInput, cb: (err: any, data?: DisconnectParticipantCommandOutput) => void): void;
|
|
42
78
|
disconnectParticipant(args: DisconnectParticipantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectParticipantCommandOutput) => void): void;
|
|
79
|
+
/**
|
|
80
|
+
* @see {@link GetCompositionCommand}
|
|
81
|
+
*/
|
|
82
|
+
getComposition(args: GetCompositionCommandInput, options?: __HttpHandlerOptions): Promise<GetCompositionCommandOutput>;
|
|
83
|
+
getComposition(args: GetCompositionCommandInput, cb: (err: any, data?: GetCompositionCommandOutput) => void): void;
|
|
84
|
+
getComposition(args: GetCompositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCompositionCommandOutput) => void): void;
|
|
85
|
+
/**
|
|
86
|
+
* @see {@link GetEncoderConfigurationCommand}
|
|
87
|
+
*/
|
|
88
|
+
getEncoderConfiguration(args: GetEncoderConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetEncoderConfigurationCommandOutput>;
|
|
89
|
+
getEncoderConfiguration(args: GetEncoderConfigurationCommandInput, cb: (err: any, data?: GetEncoderConfigurationCommandOutput) => void): void;
|
|
90
|
+
getEncoderConfiguration(args: GetEncoderConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEncoderConfigurationCommandOutput) => void): void;
|
|
43
91
|
/**
|
|
44
92
|
* @see {@link GetParticipantCommand}
|
|
45
93
|
*/
|
|
@@ -58,6 +106,24 @@ export interface IVSRealTime {
|
|
|
58
106
|
getStageSession(args: GetStageSessionCommandInput, options?: __HttpHandlerOptions): Promise<GetStageSessionCommandOutput>;
|
|
59
107
|
getStageSession(args: GetStageSessionCommandInput, cb: (err: any, data?: GetStageSessionCommandOutput) => void): void;
|
|
60
108
|
getStageSession(args: GetStageSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStageSessionCommandOutput) => void): void;
|
|
109
|
+
/**
|
|
110
|
+
* @see {@link GetStorageConfigurationCommand}
|
|
111
|
+
*/
|
|
112
|
+
getStorageConfiguration(args: GetStorageConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetStorageConfigurationCommandOutput>;
|
|
113
|
+
getStorageConfiguration(args: GetStorageConfigurationCommandInput, cb: (err: any, data?: GetStorageConfigurationCommandOutput) => void): void;
|
|
114
|
+
getStorageConfiguration(args: GetStorageConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStorageConfigurationCommandOutput) => void): void;
|
|
115
|
+
/**
|
|
116
|
+
* @see {@link ListCompositionsCommand}
|
|
117
|
+
*/
|
|
118
|
+
listCompositions(args: ListCompositionsCommandInput, options?: __HttpHandlerOptions): Promise<ListCompositionsCommandOutput>;
|
|
119
|
+
listCompositions(args: ListCompositionsCommandInput, cb: (err: any, data?: ListCompositionsCommandOutput) => void): void;
|
|
120
|
+
listCompositions(args: ListCompositionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCompositionsCommandOutput) => void): void;
|
|
121
|
+
/**
|
|
122
|
+
* @see {@link ListEncoderConfigurationsCommand}
|
|
123
|
+
*/
|
|
124
|
+
listEncoderConfigurations(args: ListEncoderConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListEncoderConfigurationsCommandOutput>;
|
|
125
|
+
listEncoderConfigurations(args: ListEncoderConfigurationsCommandInput, cb: (err: any, data?: ListEncoderConfigurationsCommandOutput) => void): void;
|
|
126
|
+
listEncoderConfigurations(args: ListEncoderConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEncoderConfigurationsCommandOutput) => void): void;
|
|
61
127
|
/**
|
|
62
128
|
* @see {@link ListParticipantEventsCommand}
|
|
63
129
|
*/
|
|
@@ -82,12 +148,30 @@ export interface IVSRealTime {
|
|
|
82
148
|
listStageSessions(args: ListStageSessionsCommandInput, options?: __HttpHandlerOptions): Promise<ListStageSessionsCommandOutput>;
|
|
83
149
|
listStageSessions(args: ListStageSessionsCommandInput, cb: (err: any, data?: ListStageSessionsCommandOutput) => void): void;
|
|
84
150
|
listStageSessions(args: ListStageSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStageSessionsCommandOutput) => void): void;
|
|
151
|
+
/**
|
|
152
|
+
* @see {@link ListStorageConfigurationsCommand}
|
|
153
|
+
*/
|
|
154
|
+
listStorageConfigurations(args: ListStorageConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListStorageConfigurationsCommandOutput>;
|
|
155
|
+
listStorageConfigurations(args: ListStorageConfigurationsCommandInput, cb: (err: any, data?: ListStorageConfigurationsCommandOutput) => void): void;
|
|
156
|
+
listStorageConfigurations(args: ListStorageConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStorageConfigurationsCommandOutput) => void): void;
|
|
85
157
|
/**
|
|
86
158
|
* @see {@link ListTagsForResourceCommand}
|
|
87
159
|
*/
|
|
88
160
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
89
161
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
90
162
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
163
|
+
/**
|
|
164
|
+
* @see {@link StartCompositionCommand}
|
|
165
|
+
*/
|
|
166
|
+
startComposition(args: StartCompositionCommandInput, options?: __HttpHandlerOptions): Promise<StartCompositionCommandOutput>;
|
|
167
|
+
startComposition(args: StartCompositionCommandInput, cb: (err: any, data?: StartCompositionCommandOutput) => void): void;
|
|
168
|
+
startComposition(args: StartCompositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCompositionCommandOutput) => void): void;
|
|
169
|
+
/**
|
|
170
|
+
* @see {@link StopCompositionCommand}
|
|
171
|
+
*/
|
|
172
|
+
stopComposition(args: StopCompositionCommandInput, options?: __HttpHandlerOptions): Promise<StopCompositionCommandOutput>;
|
|
173
|
+
stopComposition(args: StopCompositionCommandInput, cb: (err: any, data?: StopCompositionCommandOutput) => void): void;
|
|
174
|
+
stopComposition(args: StopCompositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCompositionCommandOutput) => void): void;
|
|
91
175
|
/**
|
|
92
176
|
* @see {@link TagResourceCommand}
|
|
93
177
|
*/
|
|
@@ -125,11 +209,20 @@ export interface IVSRealTime {
|
|
|
125
209
|
* <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
|
|
126
210
|
* </li>
|
|
127
211
|
* <li>
|
|
128
|
-
* <p>A <i>participant object</i> represents participants
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
212
|
+
* <p>A <i>participant object</i> represents participants (people) in the stage and
|
|
213
|
+
* contains information about them. When a token is created, it includes a participant ID;
|
|
214
|
+
* when a participant uses that token to join a stage, the participant is associated with
|
|
215
|
+
* that participant ID. There is a 1:1 mapping between participant tokens and
|
|
216
|
+
* participants.</p>
|
|
217
|
+
* </li>
|
|
218
|
+
* <li>
|
|
219
|
+
* <p>Server-side composition: The <i>composition</i> process composites participants
|
|
220
|
+
* of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
|
|
221
|
+
* Composition endpoints support this process.</p>
|
|
222
|
+
* </li>
|
|
223
|
+
* <li>
|
|
224
|
+
* <p>Server-side composition: A <i>composition</i> controls the look of the outputs,
|
|
225
|
+
* including how participants are positioned in the video.</p>
|
|
133
226
|
* </li>
|
|
134
227
|
* </ul>
|
|
135
228
|
* <p>
|
|
@@ -215,6 +308,80 @@ export interface IVSRealTime {
|
|
|
215
308
|
* </li>
|
|
216
309
|
* </ul>
|
|
217
310
|
* <p>
|
|
311
|
+
* <b>Composition Endpoints</b>
|
|
312
|
+
* </p>
|
|
313
|
+
* <ul>
|
|
314
|
+
* <li>
|
|
315
|
+
* <p>
|
|
316
|
+
* <a>GetComposition</a> — Gets information about the specified
|
|
317
|
+
* Composition resource.</p>
|
|
318
|
+
* </li>
|
|
319
|
+
* <li>
|
|
320
|
+
* <p>
|
|
321
|
+
* <a>ListCompositions</a> — Gets summary information about all
|
|
322
|
+
* Compositions in your account, in the AWS region where the API request is processed.</p>
|
|
323
|
+
* </li>
|
|
324
|
+
* <li>
|
|
325
|
+
* <p>
|
|
326
|
+
* <a>StartComposition</a> — Starts a Composition from a stage based on
|
|
327
|
+
* the configuration provided in the request.</p>
|
|
328
|
+
* </li>
|
|
329
|
+
* <li>
|
|
330
|
+
* <p>
|
|
331
|
+
* <a>StopComposition</a> — Stops and deletes a Composition resource.
|
|
332
|
+
* Any broadcast from the Composition resource is stopped.</p>
|
|
333
|
+
* </li>
|
|
334
|
+
* </ul>
|
|
335
|
+
* <p>
|
|
336
|
+
* <b>EncoderConfiguration Endpoints</b>
|
|
337
|
+
* </p>
|
|
338
|
+
* <ul>
|
|
339
|
+
* <li>
|
|
340
|
+
* <p>
|
|
341
|
+
* <a>CreateEncoderConfiguration</a> — Creates an EncoderConfiguration object.</p>
|
|
342
|
+
* </li>
|
|
343
|
+
* <li>
|
|
344
|
+
* <p>
|
|
345
|
+
* <a>DeleteEncoderConfiguration</a> — Deletes an EncoderConfiguration
|
|
346
|
+
* resource. Ensures that no Compositions are using this template; otherwise, returns an
|
|
347
|
+
* error.</p>
|
|
348
|
+
* </li>
|
|
349
|
+
* <li>
|
|
350
|
+
* <p>
|
|
351
|
+
* <a>GetEncoderConfiguration</a> — Gets information about the specified
|
|
352
|
+
* EncoderConfiguration resource.</p>
|
|
353
|
+
* </li>
|
|
354
|
+
* <li>
|
|
355
|
+
* <p>
|
|
356
|
+
* <a>ListEncoderConfigurations</a> — Gets summary information about all
|
|
357
|
+
* EncoderConfigurations in your account, in the AWS region where the API request is
|
|
358
|
+
* processed.</p>
|
|
359
|
+
* </li>
|
|
360
|
+
* </ul>
|
|
361
|
+
* <p>
|
|
362
|
+
* <b>StorageConfiguration Endpoints</b>
|
|
363
|
+
* </p>
|
|
364
|
+
* <ul>
|
|
365
|
+
* <li>
|
|
366
|
+
* <p>
|
|
367
|
+
* <a>CreateStorageConfiguration</a> — Creates a new storage configuration, used to enable
|
|
368
|
+
* recording to Amazon S3.</p>
|
|
369
|
+
* </li>
|
|
370
|
+
* <li>
|
|
371
|
+
* <p>
|
|
372
|
+
* <a>DeleteStorageConfiguration</a> — Deletes the storage configuration for the specified ARN.</p>
|
|
373
|
+
* </li>
|
|
374
|
+
* <li>
|
|
375
|
+
* <p>
|
|
376
|
+
* <a>GetStorageConfiguration</a> — Gets the storage configuration for the specified ARN.</p>
|
|
377
|
+
* </li>
|
|
378
|
+
* <li>
|
|
379
|
+
* <p>
|
|
380
|
+
* <a>ListStorageConfigurations</a> — Gets summary information about all storage configurations in your
|
|
381
|
+
* account, in the AWS region where the API request is processed.</p>
|
|
382
|
+
* </li>
|
|
383
|
+
* </ul>
|
|
384
|
+
* <p>
|
|
218
385
|
* <b>Tags Endpoints</b>
|
|
219
386
|
* </p>
|
|
220
387
|
* <ul>
|
|
@@ -8,18 +8,30 @@ import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"
|
|
|
8
8
|
import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
|
|
9
9
|
import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
|
|
10
10
|
import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
|
|
11
|
+
import { CreateEncoderConfigurationCommandInput, CreateEncoderConfigurationCommandOutput } from "./commands/CreateEncoderConfigurationCommand";
|
|
11
12
|
import { CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput } from "./commands/CreateParticipantTokenCommand";
|
|
12
13
|
import { CreateStageCommandInput, CreateStageCommandOutput } from "./commands/CreateStageCommand";
|
|
14
|
+
import { CreateStorageConfigurationCommandInput, CreateStorageConfigurationCommandOutput } from "./commands/CreateStorageConfigurationCommand";
|
|
15
|
+
import { DeleteEncoderConfigurationCommandInput, DeleteEncoderConfigurationCommandOutput } from "./commands/DeleteEncoderConfigurationCommand";
|
|
13
16
|
import { DeleteStageCommandInput, DeleteStageCommandOutput } from "./commands/DeleteStageCommand";
|
|
17
|
+
import { DeleteStorageConfigurationCommandInput, DeleteStorageConfigurationCommandOutput } from "./commands/DeleteStorageConfigurationCommand";
|
|
14
18
|
import { DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput } from "./commands/DisconnectParticipantCommand";
|
|
19
|
+
import { GetCompositionCommandInput, GetCompositionCommandOutput } from "./commands/GetCompositionCommand";
|
|
20
|
+
import { GetEncoderConfigurationCommandInput, GetEncoderConfigurationCommandOutput } from "./commands/GetEncoderConfigurationCommand";
|
|
15
21
|
import { GetParticipantCommandInput, GetParticipantCommandOutput } from "./commands/GetParticipantCommand";
|
|
16
22
|
import { GetStageCommandInput, GetStageCommandOutput } from "./commands/GetStageCommand";
|
|
17
23
|
import { GetStageSessionCommandInput, GetStageSessionCommandOutput } from "./commands/GetStageSessionCommand";
|
|
24
|
+
import { GetStorageConfigurationCommandInput, GetStorageConfigurationCommandOutput } from "./commands/GetStorageConfigurationCommand";
|
|
25
|
+
import { ListCompositionsCommandInput, ListCompositionsCommandOutput } from "./commands/ListCompositionsCommand";
|
|
26
|
+
import { ListEncoderConfigurationsCommandInput, ListEncoderConfigurationsCommandOutput } from "./commands/ListEncoderConfigurationsCommand";
|
|
18
27
|
import { ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput } from "./commands/ListParticipantEventsCommand";
|
|
19
28
|
import { ListParticipantsCommandInput, ListParticipantsCommandOutput } from "./commands/ListParticipantsCommand";
|
|
20
29
|
import { ListStagesCommandInput, ListStagesCommandOutput } from "./commands/ListStagesCommand";
|
|
21
30
|
import { ListStageSessionsCommandInput, ListStageSessionsCommandOutput } from "./commands/ListStageSessionsCommand";
|
|
31
|
+
import { ListStorageConfigurationsCommandInput, ListStorageConfigurationsCommandOutput } from "./commands/ListStorageConfigurationsCommand";
|
|
22
32
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
33
|
+
import { StartCompositionCommandInput, StartCompositionCommandOutput } from "./commands/StartCompositionCommand";
|
|
34
|
+
import { StopCompositionCommandInput, StopCompositionCommandOutput } from "./commands/StopCompositionCommand";
|
|
23
35
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
24
36
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
25
37
|
import { UpdateStageCommandInput, UpdateStageCommandOutput } from "./commands/UpdateStageCommand";
|
|
@@ -29,11 +41,11 @@ export { __Client };
|
|
|
29
41
|
/**
|
|
30
42
|
* @public
|
|
31
43
|
*/
|
|
32
|
-
export type ServiceInputTypes = CreateParticipantTokenCommandInput | CreateStageCommandInput | DeleteStageCommandInput | DisconnectParticipantCommandInput | GetParticipantCommandInput | GetStageCommandInput | GetStageSessionCommandInput | ListParticipantEventsCommandInput | ListParticipantsCommandInput | ListStageSessionsCommandInput | ListStagesCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateStageCommandInput;
|
|
44
|
+
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;
|
|
33
45
|
/**
|
|
34
46
|
* @public
|
|
35
47
|
*/
|
|
36
|
-
export type ServiceOutputTypes = CreateParticipantTokenCommandOutput | CreateStageCommandOutput | DeleteStageCommandOutput | DisconnectParticipantCommandOutput | GetParticipantCommandOutput | GetStageCommandOutput | GetStageSessionCommandOutput | ListParticipantEventsCommandOutput | ListParticipantsCommandOutput | ListStageSessionsCommandOutput | ListStagesCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateStageCommandOutput;
|
|
48
|
+
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;
|
|
37
49
|
/**
|
|
38
50
|
* @public
|
|
39
51
|
*/
|
|
@@ -183,11 +195,20 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
|
|
|
183
195
|
* <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
|
|
184
196
|
* </li>
|
|
185
197
|
* <li>
|
|
186
|
-
* <p>A <i>participant object</i> represents participants
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
198
|
+
* <p>A <i>participant object</i> represents participants (people) in the stage and
|
|
199
|
+
* contains information about them. When a token is created, it includes a participant ID;
|
|
200
|
+
* when a participant uses that token to join a stage, the participant is associated with
|
|
201
|
+
* that participant ID. There is a 1:1 mapping between participant tokens and
|
|
202
|
+
* participants.</p>
|
|
203
|
+
* </li>
|
|
204
|
+
* <li>
|
|
205
|
+
* <p>Server-side composition: The <i>composition</i> process composites participants
|
|
206
|
+
* of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
|
|
207
|
+
* Composition endpoints support this process.</p>
|
|
208
|
+
* </li>
|
|
209
|
+
* <li>
|
|
210
|
+
* <p>Server-side composition: A <i>composition</i> controls the look of the outputs,
|
|
211
|
+
* including how participants are positioned in the video.</p>
|
|
191
212
|
* </li>
|
|
192
213
|
* </ul>
|
|
193
214
|
* <p>
|
|
@@ -273,6 +294,80 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
|
|
|
273
294
|
* </li>
|
|
274
295
|
* </ul>
|
|
275
296
|
* <p>
|
|
297
|
+
* <b>Composition Endpoints</b>
|
|
298
|
+
* </p>
|
|
299
|
+
* <ul>
|
|
300
|
+
* <li>
|
|
301
|
+
* <p>
|
|
302
|
+
* <a>GetComposition</a> — Gets information about the specified
|
|
303
|
+
* Composition resource.</p>
|
|
304
|
+
* </li>
|
|
305
|
+
* <li>
|
|
306
|
+
* <p>
|
|
307
|
+
* <a>ListCompositions</a> — Gets summary information about all
|
|
308
|
+
* Compositions in your account, in the AWS region where the API request is processed.</p>
|
|
309
|
+
* </li>
|
|
310
|
+
* <li>
|
|
311
|
+
* <p>
|
|
312
|
+
* <a>StartComposition</a> — Starts a Composition from a stage based on
|
|
313
|
+
* the configuration provided in the request.</p>
|
|
314
|
+
* </li>
|
|
315
|
+
* <li>
|
|
316
|
+
* <p>
|
|
317
|
+
* <a>StopComposition</a> — Stops and deletes a Composition resource.
|
|
318
|
+
* Any broadcast from the Composition resource is stopped.</p>
|
|
319
|
+
* </li>
|
|
320
|
+
* </ul>
|
|
321
|
+
* <p>
|
|
322
|
+
* <b>EncoderConfiguration Endpoints</b>
|
|
323
|
+
* </p>
|
|
324
|
+
* <ul>
|
|
325
|
+
* <li>
|
|
326
|
+
* <p>
|
|
327
|
+
* <a>CreateEncoderConfiguration</a> — Creates an EncoderConfiguration object.</p>
|
|
328
|
+
* </li>
|
|
329
|
+
* <li>
|
|
330
|
+
* <p>
|
|
331
|
+
* <a>DeleteEncoderConfiguration</a> — Deletes an EncoderConfiguration
|
|
332
|
+
* resource. Ensures that no Compositions are using this template; otherwise, returns an
|
|
333
|
+
* error.</p>
|
|
334
|
+
* </li>
|
|
335
|
+
* <li>
|
|
336
|
+
* <p>
|
|
337
|
+
* <a>GetEncoderConfiguration</a> — Gets information about the specified
|
|
338
|
+
* EncoderConfiguration resource.</p>
|
|
339
|
+
* </li>
|
|
340
|
+
* <li>
|
|
341
|
+
* <p>
|
|
342
|
+
* <a>ListEncoderConfigurations</a> — Gets summary information about all
|
|
343
|
+
* EncoderConfigurations in your account, in the AWS region where the API request is
|
|
344
|
+
* processed.</p>
|
|
345
|
+
* </li>
|
|
346
|
+
* </ul>
|
|
347
|
+
* <p>
|
|
348
|
+
* <b>StorageConfiguration Endpoints</b>
|
|
349
|
+
* </p>
|
|
350
|
+
* <ul>
|
|
351
|
+
* <li>
|
|
352
|
+
* <p>
|
|
353
|
+
* <a>CreateStorageConfiguration</a> — Creates a new storage configuration, used to enable
|
|
354
|
+
* recording to Amazon S3.</p>
|
|
355
|
+
* </li>
|
|
356
|
+
* <li>
|
|
357
|
+
* <p>
|
|
358
|
+
* <a>DeleteStorageConfiguration</a> — Deletes the storage configuration for the specified ARN.</p>
|
|
359
|
+
* </li>
|
|
360
|
+
* <li>
|
|
361
|
+
* <p>
|
|
362
|
+
* <a>GetStorageConfiguration</a> — Gets the storage configuration for the specified ARN.</p>
|
|
363
|
+
* </li>
|
|
364
|
+
* <li>
|
|
365
|
+
* <p>
|
|
366
|
+
* <a>ListStorageConfigurations</a> — Gets summary information about all storage configurations in your
|
|
367
|
+
* account, in the AWS region where the API request is processed.</p>
|
|
368
|
+
* </li>
|
|
369
|
+
* </ul>
|
|
370
|
+
* <p>
|
|
276
371
|
* <b>Tags Endpoints</b>
|
|
277
372
|
* </p>
|
|
278
373
|
* <ul>
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
|
|
5
|
+
import { CreateEncoderConfigurationRequest, CreateEncoderConfigurationResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateEncoderConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateEncoderConfigurationCommandInput extends CreateEncoderConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateEncoderConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateEncoderConfigurationCommandOutput extends CreateEncoderConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Creates an EncoderConfiguration object.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { IVSRealTimeClient, CreateEncoderConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
31
|
+
* // const { IVSRealTimeClient, CreateEncoderConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
32
|
+
* const client = new IVSRealTimeClient(config);
|
|
33
|
+
* const input = { // CreateEncoderConfigurationRequest
|
|
34
|
+
* name: "STRING_VALUE",
|
|
35
|
+
* video: { // Video
|
|
36
|
+
* width: Number("int"),
|
|
37
|
+
* height: Number("int"),
|
|
38
|
+
* framerate: Number("float"),
|
|
39
|
+
* bitrate: Number("int"),
|
|
40
|
+
* },
|
|
41
|
+
* tags: { // Tags
|
|
42
|
+
* "<keys>": "STRING_VALUE",
|
|
43
|
+
* },
|
|
44
|
+
* };
|
|
45
|
+
* const command = new CreateEncoderConfigurationCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // CreateEncoderConfigurationResponse
|
|
48
|
+
* // encoderConfiguration: { // EncoderConfiguration
|
|
49
|
+
* // arn: "STRING_VALUE", // required
|
|
50
|
+
* // name: "STRING_VALUE",
|
|
51
|
+
* // video: { // Video
|
|
52
|
+
* // width: Number("int"),
|
|
53
|
+
* // height: Number("int"),
|
|
54
|
+
* // framerate: Number("float"),
|
|
55
|
+
* // bitrate: Number("int"),
|
|
56
|
+
* // },
|
|
57
|
+
* // tags: { // Tags
|
|
58
|
+
* // "<keys>": "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // },
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @param CreateEncoderConfigurationCommandInput - {@link CreateEncoderConfigurationCommandInput}
|
|
66
|
+
* @returns {@link CreateEncoderConfigurationCommandOutput}
|
|
67
|
+
* @see {@link CreateEncoderConfigurationCommandInput} for command's `input` shape.
|
|
68
|
+
* @see {@link CreateEncoderConfigurationCommandOutput} for command's `response` shape.
|
|
69
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
72
|
+
* <p/>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ConflictException} (client fault)
|
|
75
|
+
* <p/>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InternalServerException} (server fault)
|
|
78
|
+
* <p/>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link PendingVerification} (client fault)
|
|
81
|
+
* <p/>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p/>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
87
|
+
* <p/>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
* <p/>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
94
|
+
*
|
|
95
|
+
*/
|
|
96
|
+
export declare class CreateEncoderConfigurationCommand extends $Command<CreateEncoderConfigurationCommandInput, CreateEncoderConfigurationCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
97
|
+
readonly input: CreateEncoderConfigurationCommandInput;
|
|
98
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
99
|
+
/**
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
constructor(input: CreateEncoderConfigurationCommandInput);
|
|
103
|
+
/**
|
|
104
|
+
* @internal
|
|
105
|
+
*/
|
|
106
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateEncoderConfigurationCommandInput, CreateEncoderConfigurationCommandOutput>;
|
|
107
|
+
/**
|
|
108
|
+
* @internal
|
|
109
|
+
*/
|
|
110
|
+
private serialize;
|
|
111
|
+
/**
|
|
112
|
+
* @internal
|
|
113
|
+
*/
|
|
114
|
+
private deserialize;
|
|
115
|
+
}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
|
|
5
|
+
import { CreateStorageConfigurationRequest, CreateStorageConfigurationResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateStorageConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateStorageConfigurationCommandInput extends CreateStorageConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateStorageConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateStorageConfigurationCommandOutput extends CreateStorageConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Creates a new storage configuration, used to enable recording to Amazon S3.
|
|
27
|
+
* When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket.
|
|
28
|
+
* This will ensure that IVS has sufficient permissions to write content to the provided bucket.</p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { IVSRealTimeClient, CreateStorageConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
33
|
+
* // const { IVSRealTimeClient, CreateStorageConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
34
|
+
* const client = new IVSRealTimeClient(config);
|
|
35
|
+
* const input = { // CreateStorageConfigurationRequest
|
|
36
|
+
* name: "STRING_VALUE",
|
|
37
|
+
* s3: { // S3StorageConfiguration
|
|
38
|
+
* bucketName: "STRING_VALUE", // required
|
|
39
|
+
* },
|
|
40
|
+
* tags: { // Tags
|
|
41
|
+
* "<keys>": "STRING_VALUE",
|
|
42
|
+
* },
|
|
43
|
+
* };
|
|
44
|
+
* const command = new CreateStorageConfigurationCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // CreateStorageConfigurationResponse
|
|
47
|
+
* // storageConfiguration: { // StorageConfiguration
|
|
48
|
+
* // arn: "STRING_VALUE", // required
|
|
49
|
+
* // name: "STRING_VALUE",
|
|
50
|
+
* // s3: { // S3StorageConfiguration
|
|
51
|
+
* // bucketName: "STRING_VALUE", // required
|
|
52
|
+
* // },
|
|
53
|
+
* // tags: { // Tags
|
|
54
|
+
* // "<keys>": "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // },
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
61
|
+
* @param CreateStorageConfigurationCommandInput - {@link CreateStorageConfigurationCommandInput}
|
|
62
|
+
* @returns {@link CreateStorageConfigurationCommandOutput}
|
|
63
|
+
* @see {@link CreateStorageConfigurationCommandInput} for command's `input` shape.
|
|
64
|
+
* @see {@link CreateStorageConfigurationCommandOutput} for command's `response` shape.
|
|
65
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
68
|
+
* <p/>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ConflictException} (client fault)
|
|
71
|
+
* <p/>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InternalServerException} (server fault)
|
|
74
|
+
* <p/>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link PendingVerification} (client fault)
|
|
77
|
+
* <p/>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
80
|
+
* <p/>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
83
|
+
* <p/>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ValidationException} (client fault)
|
|
86
|
+
* <p/>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
90
|
+
*
|
|
91
|
+
*/
|
|
92
|
+
export declare class CreateStorageConfigurationCommand extends $Command<CreateStorageConfigurationCommandInput, CreateStorageConfigurationCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
93
|
+
readonly input: CreateStorageConfigurationCommandInput;
|
|
94
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
95
|
+
/**
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
constructor(input: CreateStorageConfigurationCommandInput);
|
|
99
|
+
/**
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
102
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateStorageConfigurationCommandInput, CreateStorageConfigurationCommandOutput>;
|
|
103
|
+
/**
|
|
104
|
+
* @internal
|
|
105
|
+
*/
|
|
106
|
+
private serialize;
|
|
107
|
+
/**
|
|
108
|
+
* @internal
|
|
109
|
+
*/
|
|
110
|
+
private deserialize;
|
|
111
|
+
}
|