@aws-sdk/client-ivs-realtime 3.533.0 → 3.540.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/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/IVSRealTime.d.ts +7 -1
- package/dist-types/IVSRealTimeClient.d.ts +1 -1
- package/dist-types/commands/CreateEncoderConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/CreateParticipantTokenCommand.d.ts +2 -1
- package/dist-types/commands/CreateStageCommand.d.ts +2 -1
- package/dist-types/commands/CreateStorageConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteEncoderConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteStageCommand.d.ts +2 -1
- package/dist-types/commands/DeleteStorageConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DisconnectParticipantCommand.d.ts +2 -1
- package/dist-types/commands/GetCompositionCommand.d.ts +2 -1
- package/dist-types/commands/GetEncoderConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetParticipantCommand.d.ts +2 -1
- package/dist-types/commands/GetStageCommand.d.ts +2 -1
- package/dist-types/commands/GetStageSessionCommand.d.ts +2 -1
- package/dist-types/commands/GetStorageConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/ListCompositionsCommand.d.ts +2 -1
- package/dist-types/commands/ListEncoderConfigurationsCommand.d.ts +2 -1
- package/dist-types/commands/ListParticipantEventsCommand.d.ts +2 -1
- package/dist-types/commands/ListParticipantsCommand.d.ts +2 -1
- package/dist-types/commands/ListStageSessionsCommand.d.ts +2 -1
- package/dist-types/commands/ListStagesCommand.d.ts +2 -1
- package/dist-types/commands/ListStorageConfigurationsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/StartCompositionCommand.d.ts +2 -1
- package/dist-types/commands/StopCompositionCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateStageCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +257 -257
- package/dist-types/ts3.4/IVSRealTime.d.ts +6 -0
- package/dist-types/ts3.4/commands/CreateEncoderConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateParticipantTokenCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateStageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateStorageConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteEncoderConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteStageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteStorageConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisconnectParticipantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCompositionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetEncoderConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetParticipantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetStageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetStageSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetStorageConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListCompositionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListEncoderConfigurationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListParticipantEventsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListParticipantsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStageSessionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStagesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStorageConfigurationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartCompositionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopCompositionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateStageCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { IVSRealTimeServiceException as __BaseException } from "./IVSRealTimeServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p/>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
9
9
|
readonly $fault: "client";
|
|
10
10
|
/**
|
|
11
|
-
* @public
|
|
12
11
|
* <p>User does not have sufficient access to perform this action.</p>
|
|
12
|
+
* @public
|
|
13
13
|
*/
|
|
14
14
|
exceptionMessage?: string;
|
|
15
15
|
/**
|
|
@@ -18,15 +18,15 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
18
18
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
|
-
* @public
|
|
22
21
|
* <p/>
|
|
22
|
+
* @public
|
|
23
23
|
*/
|
|
24
24
|
export declare class ConflictException extends __BaseException {
|
|
25
25
|
readonly name: "ConflictException";
|
|
26
26
|
readonly $fault: "client";
|
|
27
27
|
/**
|
|
28
|
-
* @public
|
|
29
28
|
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
29
|
+
* @public
|
|
30
30
|
*/
|
|
31
31
|
exceptionMessage?: string;
|
|
32
32
|
/**
|
|
@@ -35,32 +35,32 @@ export declare class ConflictException extends __BaseException {
|
|
|
35
35
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
* @public
|
|
39
38
|
* <p>Settings for video.</p>
|
|
39
|
+
* @public
|
|
40
40
|
*/
|
|
41
41
|
export interface Video {
|
|
42
42
|
/**
|
|
43
|
-
* @public
|
|
44
43
|
* <p>Video-resolution width. Note that the maximum value is determined by <code>width</code>
|
|
45
44
|
* times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or
|
|
46
45
|
* 1080x1920). Default: 1280.</p>
|
|
46
|
+
* @public
|
|
47
47
|
*/
|
|
48
48
|
width?: number;
|
|
49
49
|
/**
|
|
50
|
-
* @public
|
|
51
50
|
* <p>Video-resolution height. Note that the maximum value is determined by <code>width</code>
|
|
52
51
|
* times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or
|
|
53
52
|
* 1080x1920). Default: 720.</p>
|
|
53
|
+
* @public
|
|
54
54
|
*/
|
|
55
55
|
height?: number;
|
|
56
56
|
/**
|
|
57
|
-
* @public
|
|
58
57
|
* <p>Video frame rate, in fps. Default: 30.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
framerate?: number;
|
|
61
61
|
/**
|
|
62
|
-
* @public
|
|
63
62
|
* <p>Bitrate for generated output, in bps. Default: 2500000.</p>
|
|
63
|
+
* @public
|
|
64
64
|
*/
|
|
65
65
|
bitrate?: number;
|
|
66
66
|
}
|
|
@@ -69,54 +69,54 @@ export interface Video {
|
|
|
69
69
|
*/
|
|
70
70
|
export interface CreateEncoderConfigurationRequest {
|
|
71
71
|
/**
|
|
72
|
-
* @public
|
|
73
72
|
* <p>Optional name to identify the resource.</p>
|
|
73
|
+
* @public
|
|
74
74
|
*/
|
|
75
75
|
name?: string;
|
|
76
76
|
/**
|
|
77
|
-
* @public
|
|
78
77
|
* <p>Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30
|
|
79
78
|
* fps.</p>
|
|
79
|
+
* @public
|
|
80
80
|
*/
|
|
81
81
|
video?: Video;
|
|
82
82
|
/**
|
|
83
|
-
* @public
|
|
84
83
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
85
84
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
86
85
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
87
86
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
88
87
|
* there.</p>
|
|
88
|
+
* @public
|
|
89
89
|
*/
|
|
90
90
|
tags?: Record<string, string>;
|
|
91
91
|
}
|
|
92
92
|
/**
|
|
93
|
-
* @public
|
|
94
93
|
* <p>Settings for transcoding.</p>
|
|
94
|
+
* @public
|
|
95
95
|
*/
|
|
96
96
|
export interface EncoderConfiguration {
|
|
97
97
|
/**
|
|
98
|
-
* @public
|
|
99
98
|
* <p>ARN of the EncoderConfiguration resource.</p>
|
|
99
|
+
* @public
|
|
100
100
|
*/
|
|
101
101
|
arn: string | undefined;
|
|
102
102
|
/**
|
|
103
|
-
* @public
|
|
104
103
|
* <p>Optional name to identify the resource.</p>
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
name?: string;
|
|
107
107
|
/**
|
|
108
|
-
* @public
|
|
109
108
|
* <p>Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30
|
|
110
109
|
* fps</p>
|
|
110
|
+
* @public
|
|
111
111
|
*/
|
|
112
112
|
video?: Video;
|
|
113
113
|
/**
|
|
114
|
-
* @public
|
|
115
114
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
116
115
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
117
116
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
118
117
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
119
118
|
* there.</p>
|
|
119
|
+
* @public
|
|
120
120
|
*/
|
|
121
121
|
tags?: Record<string, string>;
|
|
122
122
|
}
|
|
@@ -125,21 +125,21 @@ export interface EncoderConfiguration {
|
|
|
125
125
|
*/
|
|
126
126
|
export interface CreateEncoderConfigurationResponse {
|
|
127
127
|
/**
|
|
128
|
-
* @public
|
|
129
128
|
* <p>The EncoderConfiguration that was created.</p>
|
|
129
|
+
* @public
|
|
130
130
|
*/
|
|
131
131
|
encoderConfiguration?: EncoderConfiguration;
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
* @public
|
|
135
134
|
* <p/>
|
|
135
|
+
* @public
|
|
136
136
|
*/
|
|
137
137
|
export declare class InternalServerException extends __BaseException {
|
|
138
138
|
readonly name: "InternalServerException";
|
|
139
139
|
readonly $fault: "server";
|
|
140
140
|
/**
|
|
141
|
-
* @public
|
|
142
141
|
* <p>Unexpected error during processing of request.</p>
|
|
142
|
+
* @public
|
|
143
143
|
*/
|
|
144
144
|
exceptionMessage?: string;
|
|
145
145
|
/**
|
|
@@ -148,15 +148,15 @@ export declare class InternalServerException extends __BaseException {
|
|
|
148
148
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
149
149
|
}
|
|
150
150
|
/**
|
|
151
|
-
* @public
|
|
152
151
|
* <p/>
|
|
152
|
+
* @public
|
|
153
153
|
*/
|
|
154
154
|
export declare class PendingVerification extends __BaseException {
|
|
155
155
|
readonly name: "PendingVerification";
|
|
156
156
|
readonly $fault: "client";
|
|
157
157
|
/**
|
|
158
|
-
* @public
|
|
159
158
|
* <p> Your account is pending verification. </p>
|
|
159
|
+
* @public
|
|
160
160
|
*/
|
|
161
161
|
exceptionMessage?: string;
|
|
162
162
|
/**
|
|
@@ -165,15 +165,15 @@ export declare class PendingVerification extends __BaseException {
|
|
|
165
165
|
constructor(opts: __ExceptionOptionType<PendingVerification, __BaseException>);
|
|
166
166
|
}
|
|
167
167
|
/**
|
|
168
|
-
* @public
|
|
169
168
|
* <p/>
|
|
169
|
+
* @public
|
|
170
170
|
*/
|
|
171
171
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
172
172
|
readonly name: "ResourceNotFoundException";
|
|
173
173
|
readonly $fault: "client";
|
|
174
174
|
/**
|
|
175
|
-
* @public
|
|
176
175
|
* <p>Request references a resource which does not exist.</p>
|
|
176
|
+
* @public
|
|
177
177
|
*/
|
|
178
178
|
exceptionMessage?: string;
|
|
179
179
|
/**
|
|
@@ -182,15 +182,15 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
182
182
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
183
183
|
}
|
|
184
184
|
/**
|
|
185
|
-
* @public
|
|
186
185
|
* <p/>
|
|
186
|
+
* @public
|
|
187
187
|
*/
|
|
188
188
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
189
189
|
readonly name: "ServiceQuotaExceededException";
|
|
190
190
|
readonly $fault: "client";
|
|
191
191
|
/**
|
|
192
|
-
* @public
|
|
193
192
|
* <p>Request would cause a service quota to be exceeded.</p>
|
|
193
|
+
* @public
|
|
194
194
|
*/
|
|
195
195
|
exceptionMessage?: string;
|
|
196
196
|
/**
|
|
@@ -199,15 +199,15 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
199
199
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
200
200
|
}
|
|
201
201
|
/**
|
|
202
|
-
* @public
|
|
203
202
|
* <p/>
|
|
203
|
+
* @public
|
|
204
204
|
*/
|
|
205
205
|
export declare class ValidationException extends __BaseException {
|
|
206
206
|
readonly name: "ValidationException";
|
|
207
207
|
readonly $fault: "client";
|
|
208
208
|
/**
|
|
209
|
-
* @public
|
|
210
209
|
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
210
|
+
* @public
|
|
211
211
|
*/
|
|
212
212
|
exceptionMessage?: string;
|
|
213
213
|
/**
|
|
@@ -232,88 +232,88 @@ export type ParticipantTokenCapability = (typeof ParticipantTokenCapability)[key
|
|
|
232
232
|
*/
|
|
233
233
|
export interface CreateParticipantTokenRequest {
|
|
234
234
|
/**
|
|
235
|
-
* @public
|
|
236
235
|
* <p>ARN of the stage to which this token is scoped.</p>
|
|
236
|
+
* @public
|
|
237
237
|
*/
|
|
238
238
|
stageArn: string | undefined;
|
|
239
239
|
/**
|
|
240
|
-
* @public
|
|
241
240
|
* <p>Duration (in minutes), after which the token expires. Default: 720 (12 hours).</p>
|
|
241
|
+
* @public
|
|
242
242
|
*/
|
|
243
243
|
duration?: number;
|
|
244
244
|
/**
|
|
245
|
-
* @public
|
|
246
245
|
* <p>Name that can be specified to help identify the token. This can be any UTF-8 encoded
|
|
247
246
|
* text. <i>This field is exposed to all stage participants and should not be used for
|
|
248
247
|
* personally identifying, confidential, or sensitive information.</i>
|
|
249
248
|
* </p>
|
|
249
|
+
* @public
|
|
250
250
|
*/
|
|
251
251
|
userId?: string;
|
|
252
252
|
/**
|
|
253
|
-
* @public
|
|
254
253
|
* <p>Application-provided attributes to encode into the token and attach to a stage. Map keys
|
|
255
254
|
* and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
|
|
256
255
|
* <i>This field is exposed to all stage participants and should not be used for
|
|
257
256
|
* personally identifying, confidential, or sensitive information.</i>
|
|
258
257
|
* </p>
|
|
258
|
+
* @public
|
|
259
259
|
*/
|
|
260
260
|
attributes?: Record<string, string>;
|
|
261
261
|
/**
|
|
262
|
-
* @public
|
|
263
262
|
* <p>Set of capabilities that the user is allowed to perform in the stage. Default:
|
|
264
263
|
* <code>PUBLISH, SUBSCRIBE</code>.</p>
|
|
264
|
+
* @public
|
|
265
265
|
*/
|
|
266
266
|
capabilities?: ParticipantTokenCapability[];
|
|
267
267
|
}
|
|
268
268
|
/**
|
|
269
|
-
* @public
|
|
270
269
|
* <p>Object specifying a participant token in a stage.</p>
|
|
271
270
|
* <p>
|
|
272
271
|
* <b>Important</b>: Treat tokens as opaque; i.e., do not build functionality
|
|
273
272
|
* based on token contents. The format of tokens could change in the future.</p>
|
|
273
|
+
* @public
|
|
274
274
|
*/
|
|
275
275
|
export interface ParticipantToken {
|
|
276
276
|
/**
|
|
277
|
-
* @public
|
|
278
277
|
* <p>Unique identifier for this participant token, assigned by IVS.</p>
|
|
278
|
+
* @public
|
|
279
279
|
*/
|
|
280
280
|
participantId?: string;
|
|
281
281
|
/**
|
|
282
|
-
* @public
|
|
283
282
|
* <p>The issued client token, encrypted.</p>
|
|
283
|
+
* @public
|
|
284
284
|
*/
|
|
285
285
|
token?: string;
|
|
286
286
|
/**
|
|
287
|
-
* @public
|
|
288
287
|
* <p>Customer-assigned name to help identify the token; this can be used to link a
|
|
289
288
|
* participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
|
|
290
289
|
* <i>This field is exposed to all stage participants and should not be used for
|
|
291
290
|
* personally identifying, confidential, or sensitive information.</i>
|
|
292
291
|
* </p>
|
|
292
|
+
* @public
|
|
293
293
|
*/
|
|
294
294
|
userId?: string;
|
|
295
295
|
/**
|
|
296
|
-
* @public
|
|
297
296
|
* <p>Application-provided attributes to encode into the token and attach to a stage.
|
|
298
297
|
* <i>This field is exposed to all stage participants and should not be used for
|
|
299
298
|
* personally identifying, confidential, or sensitive information.</i>
|
|
300
299
|
* </p>
|
|
300
|
+
* @public
|
|
301
301
|
*/
|
|
302
302
|
attributes?: Record<string, string>;
|
|
303
303
|
/**
|
|
304
|
-
* @public
|
|
305
304
|
* <p>Duration (in minutes), after which the participant token expires. Default: 720 (12
|
|
306
305
|
* hours).</p>
|
|
306
|
+
* @public
|
|
307
307
|
*/
|
|
308
308
|
duration?: number;
|
|
309
309
|
/**
|
|
310
|
-
* @public
|
|
311
310
|
* <p>Set of capabilities that the user is allowed to perform in the stage.</p>
|
|
311
|
+
* @public
|
|
312
312
|
*/
|
|
313
313
|
capabilities?: ParticipantTokenCapability[];
|
|
314
314
|
/**
|
|
315
|
-
* @public
|
|
316
315
|
* <p>ISO 8601 timestamp (returned as a string) for when this token expires.</p>
|
|
316
|
+
* @public
|
|
317
317
|
*/
|
|
318
318
|
expirationTime?: Date;
|
|
319
319
|
}
|
|
@@ -322,44 +322,44 @@ export interface ParticipantToken {
|
|
|
322
322
|
*/
|
|
323
323
|
export interface CreateParticipantTokenResponse {
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>The participant token that was created.</p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
participantToken?: ParticipantToken;
|
|
329
329
|
}
|
|
330
330
|
/**
|
|
331
|
-
* @public
|
|
332
331
|
* <p>Object specifying a participant token configuration in a stage.</p>
|
|
332
|
+
* @public
|
|
333
333
|
*/
|
|
334
334
|
export interface ParticipantTokenConfiguration {
|
|
335
335
|
/**
|
|
336
|
-
* @public
|
|
337
336
|
* <p>Duration (in minutes), after which the corresponding participant token expires. Default:
|
|
338
337
|
* 720 (12 hours).</p>
|
|
338
|
+
* @public
|
|
339
339
|
*/
|
|
340
340
|
duration?: number;
|
|
341
341
|
/**
|
|
342
|
-
* @public
|
|
343
342
|
* <p>Customer-assigned name to help identify the token; this can be used to link a
|
|
344
343
|
* participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
|
|
345
344
|
* <i>This field is exposed to all stage participants and should not be used for
|
|
346
345
|
* personally identifying, confidential, or sensitive information.</i>
|
|
347
346
|
* </p>
|
|
347
|
+
* @public
|
|
348
348
|
*/
|
|
349
349
|
userId?: string;
|
|
350
350
|
/**
|
|
351
|
-
* @public
|
|
352
351
|
* <p>Application-provided attributes to encode into the corresponding participant token and
|
|
353
352
|
* attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length
|
|
354
353
|
* of this field is 1 KB total. <i>This field is exposed to all stage participants and
|
|
355
354
|
* should not be used for personally identifying, confidential, or sensitive
|
|
356
355
|
* information.</i>
|
|
357
356
|
* </p>
|
|
357
|
+
* @public
|
|
358
358
|
*/
|
|
359
359
|
attributes?: Record<string, string>;
|
|
360
360
|
/**
|
|
361
|
-
* @public
|
|
362
361
|
* <p>Set of capabilities that the user is allowed to perform in the stage.</p>
|
|
362
|
+
* @public
|
|
363
363
|
*/
|
|
364
364
|
capabilities?: ParticipantTokenCapability[];
|
|
365
365
|
}
|
|
@@ -368,52 +368,52 @@ export interface ParticipantTokenConfiguration {
|
|
|
368
368
|
*/
|
|
369
369
|
export interface CreateStageRequest {
|
|
370
370
|
/**
|
|
371
|
-
* @public
|
|
372
371
|
* <p>Optional name that can be specified for the stage being created.</p>
|
|
372
|
+
* @public
|
|
373
373
|
*/
|
|
374
374
|
name?: string;
|
|
375
375
|
/**
|
|
376
|
-
* @public
|
|
377
376
|
* <p>Array of participant token configuration objects to attach to the new stage.</p>
|
|
377
|
+
* @public
|
|
378
378
|
*/
|
|
379
379
|
participantTokenConfigurations?: ParticipantTokenConfiguration[];
|
|
380
380
|
/**
|
|
381
|
-
* @public
|
|
382
381
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
383
382
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
384
383
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
385
384
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
386
385
|
* there. </p>
|
|
386
|
+
* @public
|
|
387
387
|
*/
|
|
388
388
|
tags?: Record<string, string>;
|
|
389
389
|
}
|
|
390
390
|
/**
|
|
391
|
-
* @public
|
|
392
391
|
* <p>Object specifying a stage.</p>
|
|
392
|
+
* @public
|
|
393
393
|
*/
|
|
394
394
|
export interface Stage {
|
|
395
395
|
/**
|
|
396
|
-
* @public
|
|
397
396
|
* <p>Stage ARN.</p>
|
|
397
|
+
* @public
|
|
398
398
|
*/
|
|
399
399
|
arn: string | undefined;
|
|
400
400
|
/**
|
|
401
|
-
* @public
|
|
402
401
|
* <p>Stage name.</p>
|
|
402
|
+
* @public
|
|
403
403
|
*/
|
|
404
404
|
name?: string;
|
|
405
405
|
/**
|
|
406
|
-
* @public
|
|
407
406
|
* <p>ID of the active session within the stage.</p>
|
|
407
|
+
* @public
|
|
408
408
|
*/
|
|
409
409
|
activeSessionId?: string;
|
|
410
410
|
/**
|
|
411
|
-
* @public
|
|
412
411
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
413
412
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
414
413
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
415
414
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
416
415
|
* there.</p>
|
|
416
|
+
* @public
|
|
417
417
|
*/
|
|
418
418
|
tags?: Record<string, string>;
|
|
419
419
|
}
|
|
@@ -422,26 +422,26 @@ export interface Stage {
|
|
|
422
422
|
*/
|
|
423
423
|
export interface CreateStageResponse {
|
|
424
424
|
/**
|
|
425
|
-
* @public
|
|
426
425
|
* <p>The stage that was created.</p>
|
|
426
|
+
* @public
|
|
427
427
|
*/
|
|
428
428
|
stage?: Stage;
|
|
429
429
|
/**
|
|
430
|
-
* @public
|
|
431
430
|
* <p>Participant tokens attached to the stage. These correspond to the
|
|
432
431
|
* <code>participants</code> in the request.</p>
|
|
432
|
+
* @public
|
|
433
433
|
*/
|
|
434
434
|
participantTokens?: ParticipantToken[];
|
|
435
435
|
}
|
|
436
436
|
/**
|
|
437
|
-
* @public
|
|
438
437
|
* <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
|
|
438
|
+
* @public
|
|
439
439
|
*/
|
|
440
440
|
export interface S3StorageConfiguration {
|
|
441
441
|
/**
|
|
442
|
-
* @public
|
|
443
442
|
* <p>Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration
|
|
444
443
|
* and S3 bucket must be in the same region as the Composition.</p>
|
|
444
|
+
* @public
|
|
445
445
|
*/
|
|
446
446
|
bucketName: string | undefined;
|
|
447
447
|
}
|
|
@@ -450,52 +450,52 @@ export interface S3StorageConfiguration {
|
|
|
450
450
|
*/
|
|
451
451
|
export interface CreateStorageConfigurationRequest {
|
|
452
452
|
/**
|
|
453
|
-
* @public
|
|
454
453
|
* <p>Storage configuration name. The value does not need to be unique.</p>
|
|
454
|
+
* @public
|
|
455
455
|
*/
|
|
456
456
|
name?: string;
|
|
457
457
|
/**
|
|
458
|
-
* @public
|
|
459
458
|
* <p>A complex type that contains a storage configuration for where recorded video will be stored.</p>
|
|
459
|
+
* @public
|
|
460
460
|
*/
|
|
461
461
|
s3: S3StorageConfiguration | undefined;
|
|
462
462
|
/**
|
|
463
|
-
* @public
|
|
464
463
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
465
464
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
466
465
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
467
466
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
468
467
|
* there.</p>
|
|
468
|
+
* @public
|
|
469
469
|
*/
|
|
470
470
|
tags?: Record<string, string>;
|
|
471
471
|
}
|
|
472
472
|
/**
|
|
473
|
-
* @public
|
|
474
473
|
* <p>A complex type that describes a location where recorded videos will be stored.</p>
|
|
474
|
+
* @public
|
|
475
475
|
*/
|
|
476
476
|
export interface StorageConfiguration {
|
|
477
477
|
/**
|
|
478
|
-
* @public
|
|
479
478
|
* <p>ARN of the storage configuration.</p>
|
|
479
|
+
* @public
|
|
480
480
|
*/
|
|
481
481
|
arn: string | undefined;
|
|
482
482
|
/**
|
|
483
|
-
* @public
|
|
484
483
|
* <p>Name of the storage configuration.</p>
|
|
484
|
+
* @public
|
|
485
485
|
*/
|
|
486
486
|
name?: string;
|
|
487
487
|
/**
|
|
488
|
-
* @public
|
|
489
488
|
* <p>An S3 destination configuration where recorded videos will be stored.</p>
|
|
489
|
+
* @public
|
|
490
490
|
*/
|
|
491
491
|
s3?: S3StorageConfiguration;
|
|
492
492
|
/**
|
|
493
|
-
* @public
|
|
494
493
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
495
494
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
496
495
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
497
496
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
498
497
|
* there.</p>
|
|
498
|
+
* @public
|
|
499
499
|
*/
|
|
500
500
|
tags?: Record<string, string>;
|
|
501
501
|
}
|
|
@@ -504,8 +504,8 @@ export interface StorageConfiguration {
|
|
|
504
504
|
*/
|
|
505
505
|
export interface CreateStorageConfigurationResponse {
|
|
506
506
|
/**
|
|
507
|
-
* @public
|
|
508
507
|
* <p>The StorageConfiguration that was created.</p>
|
|
508
|
+
* @public
|
|
509
509
|
*/
|
|
510
510
|
storageConfiguration?: StorageConfiguration;
|
|
511
511
|
}
|
|
@@ -514,8 +514,8 @@ export interface CreateStorageConfigurationResponse {
|
|
|
514
514
|
*/
|
|
515
515
|
export interface DeleteEncoderConfigurationRequest {
|
|
516
516
|
/**
|
|
517
|
-
* @public
|
|
518
517
|
* <p>ARN of the EncoderConfiguration.</p>
|
|
518
|
+
* @public
|
|
519
519
|
*/
|
|
520
520
|
arn: string | undefined;
|
|
521
521
|
}
|
|
@@ -529,8 +529,8 @@ export interface DeleteEncoderConfigurationResponse {
|
|
|
529
529
|
*/
|
|
530
530
|
export interface DeleteStageRequest {
|
|
531
531
|
/**
|
|
532
|
-
* @public
|
|
533
532
|
* <p>ARN of the stage to be deleted.</p>
|
|
533
|
+
* @public
|
|
534
534
|
*/
|
|
535
535
|
arn: string | undefined;
|
|
536
536
|
}
|
|
@@ -544,8 +544,8 @@ export interface DeleteStageResponse {
|
|
|
544
544
|
*/
|
|
545
545
|
export interface DeleteStorageConfigurationRequest {
|
|
546
546
|
/**
|
|
547
|
-
* @public
|
|
548
547
|
* <p>ARN of the storage configuration to be deleted.</p>
|
|
548
|
+
* @public
|
|
549
549
|
*/
|
|
550
550
|
arn: string | undefined;
|
|
551
551
|
}
|
|
@@ -559,19 +559,19 @@ export interface DeleteStorageConfigurationResponse {
|
|
|
559
559
|
*/
|
|
560
560
|
export interface DisconnectParticipantRequest {
|
|
561
561
|
/**
|
|
562
|
-
* @public
|
|
563
562
|
* <p>ARN of the stage to which the participant is attached.</p>
|
|
563
|
+
* @public
|
|
564
564
|
*/
|
|
565
565
|
stageArn: string | undefined;
|
|
566
566
|
/**
|
|
567
|
-
* @public
|
|
568
567
|
* <p>Identifier of the participant to be disconnected. This is assigned by IVS and returned
|
|
569
568
|
* by <a>CreateParticipantToken</a>.</p>
|
|
569
|
+
* @public
|
|
570
570
|
*/
|
|
571
571
|
participantId: string | undefined;
|
|
572
572
|
/**
|
|
573
|
-
* @public
|
|
574
573
|
* <p>Description of why this participant is being disconnected.</p>
|
|
574
|
+
* @public
|
|
575
575
|
*/
|
|
576
576
|
reason?: string;
|
|
577
577
|
}
|
|
@@ -585,26 +585,26 @@ export interface DisconnectParticipantResponse {
|
|
|
585
585
|
*/
|
|
586
586
|
export interface GetCompositionRequest {
|
|
587
587
|
/**
|
|
588
|
-
* @public
|
|
589
588
|
* <p>ARN of the Composition resource.</p>
|
|
589
|
+
* @public
|
|
590
590
|
*/
|
|
591
591
|
arn: string | undefined;
|
|
592
592
|
}
|
|
593
593
|
/**
|
|
594
|
-
* @public
|
|
595
594
|
* <p>Object specifying a channel as a destination.</p>
|
|
595
|
+
* @public
|
|
596
596
|
*/
|
|
597
597
|
export interface ChannelDestinationConfiguration {
|
|
598
598
|
/**
|
|
599
|
-
* @public
|
|
600
599
|
* <p>ARN of the channel to use for broadcasting. The channel and stage resources must be in
|
|
601
600
|
* the same AWS account and region. The channel must be offline (not broadcasting).</p>
|
|
601
|
+
* @public
|
|
602
602
|
*/
|
|
603
603
|
channelArn: string | undefined;
|
|
604
604
|
/**
|
|
605
|
-
* @public
|
|
606
605
|
* <p>ARN of the <a>EncoderConfiguration</a> resource. The encoder configuration
|
|
607
606
|
* and stage resources must be in the same AWS account and region.</p>
|
|
607
|
+
* @public
|
|
608
608
|
*/
|
|
609
609
|
encoderConfigurationArn?: string;
|
|
610
610
|
}
|
|
@@ -620,82 +620,82 @@ export declare const RecordingConfigurationFormat: {
|
|
|
620
620
|
*/
|
|
621
621
|
export type RecordingConfigurationFormat = (typeof RecordingConfigurationFormat)[keyof typeof RecordingConfigurationFormat];
|
|
622
622
|
/**
|
|
623
|
-
* @public
|
|
624
623
|
* <p>An object representing a configuration to record a stage stream.</p>
|
|
624
|
+
* @public
|
|
625
625
|
*/
|
|
626
626
|
export interface RecordingConfiguration {
|
|
627
627
|
/**
|
|
628
|
-
* @public
|
|
629
628
|
* <p>The recording format for storing a recording in Amazon S3.</p>
|
|
629
|
+
* @public
|
|
630
630
|
*/
|
|
631
631
|
format?: RecordingConfigurationFormat;
|
|
632
632
|
}
|
|
633
633
|
/**
|
|
634
|
-
* @public
|
|
635
634
|
* <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
|
|
635
|
+
* @public
|
|
636
636
|
*/
|
|
637
637
|
export interface S3DestinationConfiguration {
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>ARN of the <a>StorageConfiguration</a> where recorded videos will be stored.</p>
|
|
640
|
+
* @public
|
|
641
641
|
*/
|
|
642
642
|
storageConfigurationArn: string | undefined;
|
|
643
643
|
/**
|
|
644
|
-
* @public
|
|
645
644
|
* <p>ARNs of the <a>EncoderConfiguration</a> resource. The encoder configuration and stage resources
|
|
646
645
|
* must be in the same AWS account and region. </p>
|
|
646
|
+
* @public
|
|
647
647
|
*/
|
|
648
648
|
encoderConfigurationArns: string[] | undefined;
|
|
649
649
|
/**
|
|
650
|
-
* @public
|
|
651
650
|
* <p>Array of maps, each of the form <code>string:string (key:value)</code>.
|
|
652
651
|
* This is an optional customer specification, currently used only to specify
|
|
653
652
|
* the recording format for storing a recording in Amazon S3.</p>
|
|
653
|
+
* @public
|
|
654
654
|
*/
|
|
655
655
|
recordingConfiguration?: RecordingConfiguration;
|
|
656
656
|
}
|
|
657
657
|
/**
|
|
658
|
-
* @public
|
|
659
658
|
* <p>Complex data type that defines destination-configuration objects.</p>
|
|
659
|
+
* @public
|
|
660
660
|
*/
|
|
661
661
|
export interface DestinationConfiguration {
|
|
662
662
|
/**
|
|
663
|
-
* @public
|
|
664
663
|
* <p>Name that can be specified to help identify the destination.</p>
|
|
664
|
+
* @public
|
|
665
665
|
*/
|
|
666
666
|
name?: string;
|
|
667
667
|
/**
|
|
668
|
-
* @public
|
|
669
668
|
* <p>An IVS channel to be used for broadcasting, for server-side composition. Either a <code>channel</code> or an
|
|
670
669
|
* <code>s3</code> must be specified. </p>
|
|
670
|
+
* @public
|
|
671
671
|
*/
|
|
672
672
|
channel?: ChannelDestinationConfiguration;
|
|
673
673
|
/**
|
|
674
|
-
* @public
|
|
675
674
|
* <p>An S3 storage configuration to be used for recording video data. Either a <code>channel</code>
|
|
676
675
|
* or an <code>s3</code> must be specified.</p>
|
|
676
|
+
* @public
|
|
677
677
|
*/
|
|
678
678
|
s3?: S3DestinationConfiguration;
|
|
679
679
|
}
|
|
680
680
|
/**
|
|
681
|
-
* @public
|
|
682
681
|
* <p>Complex data type that defines S3Detail objects.</p>
|
|
682
|
+
* @public
|
|
683
683
|
*/
|
|
684
684
|
export interface S3Detail {
|
|
685
685
|
/**
|
|
686
|
-
* @public
|
|
687
686
|
* <p>The S3 bucket prefix under which the recording is stored.</p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
recordingPrefix: string | undefined;
|
|
690
690
|
}
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>Complex data type that defines destination-detail objects.</p>
|
|
693
|
+
* @public
|
|
694
694
|
*/
|
|
695
695
|
export interface DestinationDetail {
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* <p>An S3 detail object to return information about the S3 destination.</p>
|
|
698
|
+
* @public
|
|
699
699
|
*/
|
|
700
700
|
s3?: S3Detail;
|
|
701
701
|
}
|
|
@@ -716,40 +716,40 @@ export declare const DestinationState: {
|
|
|
716
716
|
*/
|
|
717
717
|
export type DestinationState = (typeof DestinationState)[keyof typeof DestinationState];
|
|
718
718
|
/**
|
|
719
|
-
* @public
|
|
720
719
|
* <p>Object specifying the status of a Destination.</p>
|
|
720
|
+
* @public
|
|
721
721
|
*/
|
|
722
722
|
export interface Destination {
|
|
723
723
|
/**
|
|
724
|
-
* @public
|
|
725
724
|
* <p>Unique identifier for this destination, assigned by IVS.</p>
|
|
725
|
+
* @public
|
|
726
726
|
*/
|
|
727
727
|
id: string | undefined;
|
|
728
728
|
/**
|
|
729
|
-
* @public
|
|
730
729
|
* <p>State of the Composition Destination.</p>
|
|
730
|
+
* @public
|
|
731
731
|
*/
|
|
732
732
|
state: DestinationState | undefined;
|
|
733
733
|
/**
|
|
734
|
-
* @public
|
|
735
734
|
* <p>UTC time of the destination start. This is an ISO 8601 timestamp; <i>note that
|
|
736
735
|
* this is returned as a string</i>.</p>
|
|
736
|
+
* @public
|
|
737
737
|
*/
|
|
738
738
|
startTime?: Date;
|
|
739
739
|
/**
|
|
740
|
-
* @public
|
|
741
740
|
* <p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this
|
|
742
741
|
* is returned as a string</i>.</p>
|
|
742
|
+
* @public
|
|
743
743
|
*/
|
|
744
744
|
endTime?: Date;
|
|
745
745
|
/**
|
|
746
|
-
* @public
|
|
747
746
|
* <p>Configuration used to create this destination.</p>
|
|
747
|
+
* @public
|
|
748
748
|
*/
|
|
749
749
|
configuration: DestinationConfiguration | undefined;
|
|
750
750
|
/**
|
|
751
|
-
* @public
|
|
752
751
|
* <p>Optional details regarding the status of the destination.</p>
|
|
752
|
+
* @public
|
|
753
753
|
*/
|
|
754
754
|
detail?: DestinationDetail;
|
|
755
755
|
}
|
|
@@ -781,39 +781,39 @@ export declare const VideoFillMode: {
|
|
|
781
781
|
*/
|
|
782
782
|
export type VideoFillMode = (typeof VideoFillMode)[keyof typeof VideoFillMode];
|
|
783
783
|
/**
|
|
784
|
-
* @public
|
|
785
784
|
* <p>Configuration information specific to Grid layout, for server-side composition. See
|
|
786
785
|
* "Layouts" in <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html">Server-Side
|
|
787
786
|
* Composition</a>.</p>
|
|
787
|
+
* @public
|
|
788
788
|
*/
|
|
789
789
|
export interface GridConfiguration {
|
|
790
790
|
/**
|
|
791
|
-
* @public
|
|
792
791
|
* <p>This attribute name identifies the featured slot. A participant with this attribute set
|
|
793
792
|
* to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured
|
|
794
793
|
* slot.</p>
|
|
794
|
+
* @public
|
|
795
795
|
*/
|
|
796
796
|
featuredParticipantAttribute?: string;
|
|
797
797
|
/**
|
|
798
|
-
* @public
|
|
799
798
|
* <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
|
|
799
|
+
* @public
|
|
800
800
|
*/
|
|
801
801
|
omitStoppedVideo?: boolean;
|
|
802
802
|
/**
|
|
803
|
-
* @public
|
|
804
803
|
* <p>Sets the non-featured participant display mode. Default: <code>VIDEO</code>.</p>
|
|
804
|
+
* @public
|
|
805
805
|
*/
|
|
806
806
|
videoAspectRatio?: VideoAspectRatio;
|
|
807
807
|
/**
|
|
808
|
-
* @public
|
|
809
808
|
* <p>Defines how video fits within the participant tile. When not set,
|
|
810
809
|
* <code>videoFillMode</code> defaults to <code>COVER</code> fill mode for participants in the grid
|
|
811
810
|
* and to <code>CONTAIN</code> fill mode for featured participants.</p>
|
|
811
|
+
* @public
|
|
812
812
|
*/
|
|
813
813
|
videoFillMode?: VideoFillMode;
|
|
814
814
|
/**
|
|
815
|
-
* @public
|
|
816
815
|
* <p>Specifies the spacing between participant tiles in pixels. Default: <code>2</code>.</p>
|
|
816
|
+
* @public
|
|
817
817
|
*/
|
|
818
818
|
gridGap?: number;
|
|
819
819
|
}
|
|
@@ -844,86 +844,86 @@ export declare const PipPosition: {
|
|
|
844
844
|
*/
|
|
845
845
|
export type PipPosition = (typeof PipPosition)[keyof typeof PipPosition];
|
|
846
846
|
/**
|
|
847
|
-
* @public
|
|
848
847
|
* <p>Configuration information specific to Picture-in-Picture (PiP) layout,
|
|
849
848
|
* for <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html">server-side composition</a>.
|
|
850
849
|
* </p>
|
|
850
|
+
* @public
|
|
851
851
|
*/
|
|
852
852
|
export interface PipConfiguration {
|
|
853
853
|
/**
|
|
854
|
-
* @public
|
|
855
854
|
* <p>This attribute name identifies the featured slot. A participant with this attribute set
|
|
856
855
|
* to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured
|
|
857
856
|
* slot.</p>
|
|
857
|
+
* @public
|
|
858
858
|
*/
|
|
859
859
|
featuredParticipantAttribute?: string;
|
|
860
860
|
/**
|
|
861
|
-
* @public
|
|
862
861
|
* <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
|
|
862
|
+
* @public
|
|
863
863
|
*/
|
|
864
864
|
omitStoppedVideo?: boolean;
|
|
865
865
|
/**
|
|
866
|
-
* @public
|
|
867
866
|
* <p>Defines how video fits within the participant tile. Default: <code>COVER</code>.
|
|
868
867
|
* </p>
|
|
868
|
+
* @public
|
|
869
869
|
*/
|
|
870
870
|
videoFillMode?: VideoFillMode;
|
|
871
871
|
/**
|
|
872
|
-
* @public
|
|
873
872
|
* <p>Specifies the spacing between participant tiles in pixels. Default: <code>0</code>.</p>
|
|
873
|
+
* @public
|
|
874
874
|
*/
|
|
875
875
|
gridGap?: number;
|
|
876
876
|
/**
|
|
877
|
-
* @public
|
|
878
877
|
* <p>Identifies the PiP slot. A participant with this attribute set
|
|
879
878
|
* to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a>
|
|
880
879
|
* is placed in the PiP slot.</p>
|
|
880
|
+
* @public
|
|
881
881
|
*/
|
|
882
882
|
pipParticipantAttribute?: string;
|
|
883
883
|
/**
|
|
884
|
-
* @public
|
|
885
884
|
* <p>Defines PiP behavior when all participants have left. Default: <code>STATIC</code>.</p>
|
|
885
|
+
* @public
|
|
886
886
|
*/
|
|
887
887
|
pipBehavior?: PipBehavior;
|
|
888
888
|
/**
|
|
889
|
-
* @public
|
|
890
889
|
* <p>Sets the PiP window’s offset position in pixels from the closest edges determined by <code>PipPosition</code>.
|
|
891
890
|
* Default: <code>0</code>.</p>
|
|
891
|
+
* @public
|
|
892
892
|
*/
|
|
893
893
|
pipOffset?: number;
|
|
894
894
|
/**
|
|
895
|
-
* @public
|
|
896
895
|
* <p>Determines the corner position of the PiP window. Default: <code>BOTTOM_RIGHT</code>.</p>
|
|
896
|
+
* @public
|
|
897
897
|
*/
|
|
898
898
|
pipPosition?: PipPosition;
|
|
899
899
|
/**
|
|
900
|
-
* @public
|
|
901
900
|
* <p>Specifies the width of the PiP window in pixels. When this is not set explicitly,
|
|
902
901
|
* <code>pipWidth</code>’s value will be based on the size of the composition and the
|
|
903
902
|
* aspect ratio of the participant’s video.</p>
|
|
903
|
+
* @public
|
|
904
904
|
*/
|
|
905
905
|
pipWidth?: number;
|
|
906
906
|
/**
|
|
907
|
-
* @public
|
|
908
907
|
* <p>Specifies the height of the PiP window in pixels. When this is not set explicitly,
|
|
909
908
|
* <code>pipHeight</code>’s value will be based on the size of the composition and the
|
|
910
909
|
* aspect ratio of the participant’s video.</p>
|
|
910
|
+
* @public
|
|
911
911
|
*/
|
|
912
912
|
pipHeight?: number;
|
|
913
913
|
}
|
|
914
914
|
/**
|
|
915
|
-
* @public
|
|
916
915
|
* <p>Configuration information of supported layouts for server-side composition.</p>
|
|
916
|
+
* @public
|
|
917
917
|
*/
|
|
918
918
|
export interface LayoutConfiguration {
|
|
919
919
|
/**
|
|
920
|
-
* @public
|
|
921
920
|
* <p>Configuration related to grid layout. Default: Grid layout.</p>
|
|
921
|
+
* @public
|
|
922
922
|
*/
|
|
923
923
|
grid?: GridConfiguration;
|
|
924
924
|
/**
|
|
925
|
-
* @public
|
|
926
925
|
* <p>Configuration related to PiP layout.</p>
|
|
926
|
+
* @public
|
|
927
927
|
*/
|
|
928
928
|
pip?: PipConfiguration;
|
|
929
929
|
}
|
|
@@ -943,55 +943,55 @@ export declare const CompositionState: {
|
|
|
943
943
|
*/
|
|
944
944
|
export type CompositionState = (typeof CompositionState)[keyof typeof CompositionState];
|
|
945
945
|
/**
|
|
946
|
-
* @public
|
|
947
946
|
* <p>Object specifying a Composition resource.</p>
|
|
947
|
+
* @public
|
|
948
948
|
*/
|
|
949
949
|
export interface Composition {
|
|
950
950
|
/**
|
|
951
|
-
* @public
|
|
952
951
|
* <p>ARN of the Composition resource.</p>
|
|
952
|
+
* @public
|
|
953
953
|
*/
|
|
954
954
|
arn: string | undefined;
|
|
955
955
|
/**
|
|
956
|
-
* @public
|
|
957
956
|
* <p>ARN of the stage used as input</p>
|
|
957
|
+
* @public
|
|
958
958
|
*/
|
|
959
959
|
stageArn: string | undefined;
|
|
960
960
|
/**
|
|
961
|
-
* @public
|
|
962
961
|
* <p>State of the Composition.</p>
|
|
962
|
+
* @public
|
|
963
963
|
*/
|
|
964
964
|
state: CompositionState | undefined;
|
|
965
965
|
/**
|
|
966
|
-
* @public
|
|
967
966
|
* <p>Layout object to configure composition parameters.</p>
|
|
967
|
+
* @public
|
|
968
968
|
*/
|
|
969
969
|
layout: LayoutConfiguration | undefined;
|
|
970
970
|
/**
|
|
971
|
-
* @public
|
|
972
971
|
* <p>Array of Destination objects. A Composition can contain either one destination
|
|
973
972
|
* (<code>channel</code> or <code>s3</code>) or two (one <code>channel</code> and one <code>s3</code>).</p>
|
|
973
|
+
* @public
|
|
974
974
|
*/
|
|
975
975
|
destinations: Destination[] | undefined;
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
979
978
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
980
979
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
981
980
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
982
981
|
* there.</p>
|
|
982
|
+
* @public
|
|
983
983
|
*/
|
|
984
984
|
tags?: Record<string, string>;
|
|
985
985
|
/**
|
|
986
|
-
* @public
|
|
987
986
|
* <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
|
|
988
987
|
* this is returned as a string</i>.</p>
|
|
988
|
+
* @public
|
|
989
989
|
*/
|
|
990
990
|
startTime?: Date;
|
|
991
991
|
/**
|
|
992
|
-
* @public
|
|
993
992
|
* <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that
|
|
994
993
|
* this is returned as a string</i>.</p>
|
|
994
|
+
* @public
|
|
995
995
|
*/
|
|
996
996
|
endTime?: Date;
|
|
997
997
|
}
|
|
@@ -1000,8 +1000,8 @@ export interface Composition {
|
|
|
1000
1000
|
*/
|
|
1001
1001
|
export interface GetCompositionResponse {
|
|
1002
1002
|
/**
|
|
1003
|
-
* @public
|
|
1004
1003
|
* <p>The Composition that was returned.</p>
|
|
1004
|
+
* @public
|
|
1005
1005
|
*/
|
|
1006
1006
|
composition?: Composition;
|
|
1007
1007
|
}
|
|
@@ -1010,8 +1010,8 @@ export interface GetCompositionResponse {
|
|
|
1010
1010
|
*/
|
|
1011
1011
|
export interface GetEncoderConfigurationRequest {
|
|
1012
1012
|
/**
|
|
1013
|
-
* @public
|
|
1014
1013
|
* <p>ARN of the EncoderConfiguration resource.</p>
|
|
1014
|
+
* @public
|
|
1015
1015
|
*/
|
|
1016
1016
|
arn: string | undefined;
|
|
1017
1017
|
}
|
|
@@ -1020,8 +1020,8 @@ export interface GetEncoderConfigurationRequest {
|
|
|
1020
1020
|
*/
|
|
1021
1021
|
export interface GetEncoderConfigurationResponse {
|
|
1022
1022
|
/**
|
|
1023
|
-
* @public
|
|
1024
1023
|
* <p>The EncoderConfiguration that was returned.</p>
|
|
1024
|
+
* @public
|
|
1025
1025
|
*/
|
|
1026
1026
|
encoderConfiguration?: EncoderConfiguration;
|
|
1027
1027
|
}
|
|
@@ -1030,18 +1030,18 @@ export interface GetEncoderConfigurationResponse {
|
|
|
1030
1030
|
*/
|
|
1031
1031
|
export interface GetParticipantRequest {
|
|
1032
1032
|
/**
|
|
1033
|
-
* @public
|
|
1034
1033
|
* <p>Stage ARN.</p>
|
|
1034
|
+
* @public
|
|
1035
1035
|
*/
|
|
1036
1036
|
stageArn: string | undefined;
|
|
1037
1037
|
/**
|
|
1038
|
-
* @public
|
|
1039
1038
|
* <p>ID of a session within the stage.</p>
|
|
1039
|
+
* @public
|
|
1040
1040
|
*/
|
|
1041
1041
|
sessionId: string | undefined;
|
|
1042
1042
|
/**
|
|
1043
|
-
* @public
|
|
1044
1043
|
* <p>Unique identifier for the participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.</p>
|
|
1044
|
+
* @public
|
|
1045
1045
|
*/
|
|
1046
1046
|
participantId: string | undefined;
|
|
1047
1047
|
}
|
|
@@ -1058,75 +1058,75 @@ export declare const ParticipantState: {
|
|
|
1058
1058
|
*/
|
|
1059
1059
|
export type ParticipantState = (typeof ParticipantState)[keyof typeof ParticipantState];
|
|
1060
1060
|
/**
|
|
1061
|
-
* @public
|
|
1062
1061
|
* <p>Object describing a participant that has joined a stage.</p>
|
|
1062
|
+
* @public
|
|
1063
1063
|
*/
|
|
1064
1064
|
export interface Participant {
|
|
1065
1065
|
/**
|
|
1066
|
-
* @public
|
|
1067
1066
|
* <p>Unique identifier for this participant, assigned by IVS.</p>
|
|
1067
|
+
* @public
|
|
1068
1068
|
*/
|
|
1069
1069
|
participantId?: string;
|
|
1070
1070
|
/**
|
|
1071
|
-
* @public
|
|
1072
1071
|
* <p>Customer-assigned name to help identify the token; this can be used to link a
|
|
1073
1072
|
* participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
|
|
1074
1073
|
* <i>This field is exposed to all stage participants and should not be used for
|
|
1075
1074
|
* personally identifying, confidential, or sensitive information</i>.</p>
|
|
1075
|
+
* @public
|
|
1076
1076
|
*/
|
|
1077
1077
|
userId?: string;
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>Whether the participant is connected to or disconnected from the stage.</p>
|
|
1080
|
+
* @public
|
|
1081
1081
|
*/
|
|
1082
1082
|
state?: ParticipantState;
|
|
1083
1083
|
/**
|
|
1084
|
-
* @public
|
|
1085
1084
|
* <p>ISO 8601 timestamp (returned as a string) when the participant first joined the stage
|
|
1086
1085
|
* session.</p>
|
|
1086
|
+
* @public
|
|
1087
1087
|
*/
|
|
1088
1088
|
firstJoinTime?: Date;
|
|
1089
1089
|
/**
|
|
1090
|
-
* @public
|
|
1091
1090
|
* <p>Application-provided attributes to encode into the token and attach to a stage. Map keys
|
|
1092
1091
|
* and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
|
|
1093
1092
|
* <i>This field is exposed to all stage participants and should not be used for
|
|
1094
1093
|
* personally identifying, confidential, or sensitive information</i>.</p>
|
|
1094
|
+
* @public
|
|
1095
1095
|
*/
|
|
1096
1096
|
attributes?: Record<string, string>;
|
|
1097
1097
|
/**
|
|
1098
|
-
* @public
|
|
1099
1098
|
* <p>Whether the participant ever published to the stage session.</p>
|
|
1099
|
+
* @public
|
|
1100
1100
|
*/
|
|
1101
1101
|
published?: boolean;
|
|
1102
1102
|
/**
|
|
1103
|
-
* @public
|
|
1104
1103
|
* <p>The participant’s Internet Service Provider.</p>
|
|
1104
|
+
* @public
|
|
1105
1105
|
*/
|
|
1106
1106
|
ispName?: string;
|
|
1107
1107
|
/**
|
|
1108
|
-
* @public
|
|
1109
1108
|
* <p>The participant’s operating system.</p>
|
|
1109
|
+
* @public
|
|
1110
1110
|
*/
|
|
1111
1111
|
osName?: string;
|
|
1112
1112
|
/**
|
|
1113
|
-
* @public
|
|
1114
1113
|
* <p>The participant’s operating system version.</p>
|
|
1114
|
+
* @public
|
|
1115
1115
|
*/
|
|
1116
1116
|
osVersion?: string;
|
|
1117
1117
|
/**
|
|
1118
|
-
* @public
|
|
1119
1118
|
* <p>The participant’s browser.</p>
|
|
1119
|
+
* @public
|
|
1120
1120
|
*/
|
|
1121
1121
|
browserName?: string;
|
|
1122
1122
|
/**
|
|
1123
|
-
* @public
|
|
1124
1123
|
* <p>The participant’s browser version.</p>
|
|
1124
|
+
* @public
|
|
1125
1125
|
*/
|
|
1126
1126
|
browserVersion?: string;
|
|
1127
1127
|
/**
|
|
1128
|
-
* @public
|
|
1129
1128
|
* <p>The participant’s SDK version.</p>
|
|
1129
|
+
* @public
|
|
1130
1130
|
*/
|
|
1131
1131
|
sdkVersion?: string;
|
|
1132
1132
|
}
|
|
@@ -1135,8 +1135,8 @@ export interface Participant {
|
|
|
1135
1135
|
*/
|
|
1136
1136
|
export interface GetParticipantResponse {
|
|
1137
1137
|
/**
|
|
1138
|
-
* @public
|
|
1139
1138
|
* <p>The participant that is returned.</p>
|
|
1139
|
+
* @public
|
|
1140
1140
|
*/
|
|
1141
1141
|
participant?: Participant;
|
|
1142
1142
|
}
|
|
@@ -1145,8 +1145,8 @@ export interface GetParticipantResponse {
|
|
|
1145
1145
|
*/
|
|
1146
1146
|
export interface GetStageRequest {
|
|
1147
1147
|
/**
|
|
1148
|
-
* @public
|
|
1149
1148
|
* <p>ARN of the stage for which the information is to be retrieved.</p>
|
|
1149
|
+
* @public
|
|
1150
1150
|
*/
|
|
1151
1151
|
arn: string | undefined;
|
|
1152
1152
|
}
|
|
@@ -1155,8 +1155,8 @@ export interface GetStageRequest {
|
|
|
1155
1155
|
*/
|
|
1156
1156
|
export interface GetStageResponse {
|
|
1157
1157
|
/**
|
|
1158
|
-
* @public
|
|
1159
1158
|
* <p>The stage that is returned.</p>
|
|
1159
|
+
* @public
|
|
1160
1160
|
*/
|
|
1161
1161
|
stage?: Stage;
|
|
1162
1162
|
}
|
|
@@ -1165,38 +1165,38 @@ export interface GetStageResponse {
|
|
|
1165
1165
|
*/
|
|
1166
1166
|
export interface GetStageSessionRequest {
|
|
1167
1167
|
/**
|
|
1168
|
-
* @public
|
|
1169
1168
|
* <p>ARN of the stage for which the information is to be retrieved.</p>
|
|
1169
|
+
* @public
|
|
1170
1170
|
*/
|
|
1171
1171
|
stageArn: string | undefined;
|
|
1172
1172
|
/**
|
|
1173
|
-
* @public
|
|
1174
1173
|
* <p>ID of a session within the stage.</p>
|
|
1174
|
+
* @public
|
|
1175
1175
|
*/
|
|
1176
1176
|
sessionId: string | undefined;
|
|
1177
1177
|
}
|
|
1178
1178
|
/**
|
|
1179
|
-
* @public
|
|
1180
1179
|
* <p>A stage session begins when the first participant joins a stage and ends after the last
|
|
1181
1180
|
* participant leaves the stage. A stage session helps with debugging stages by grouping
|
|
1182
1181
|
* events and participants into shorter periods of time (i.e., a session), which is helpful
|
|
1183
1182
|
* when stages are used over long periods of time.</p>
|
|
1183
|
+
* @public
|
|
1184
1184
|
*/
|
|
1185
1185
|
export interface StageSession {
|
|
1186
1186
|
/**
|
|
1187
|
-
* @public
|
|
1188
1187
|
* <p>ID of the session within the stage.</p>
|
|
1188
|
+
* @public
|
|
1189
1189
|
*/
|
|
1190
1190
|
sessionId?: string;
|
|
1191
1191
|
/**
|
|
1192
|
-
* @public
|
|
1193
1192
|
* <p> ISO 8601 timestamp (returned as a string) when this stage session began.</p>
|
|
1193
|
+
* @public
|
|
1194
1194
|
*/
|
|
1195
1195
|
startTime?: Date;
|
|
1196
1196
|
/**
|
|
1197
|
-
* @public
|
|
1198
1197
|
* <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if
|
|
1199
1198
|
* the stage is active.</p>
|
|
1199
|
+
* @public
|
|
1200
1200
|
*/
|
|
1201
1201
|
endTime?: Date;
|
|
1202
1202
|
}
|
|
@@ -1205,8 +1205,8 @@ export interface StageSession {
|
|
|
1205
1205
|
*/
|
|
1206
1206
|
export interface GetStageSessionResponse {
|
|
1207
1207
|
/**
|
|
1208
|
-
* @public
|
|
1209
1208
|
* <p>The stage session that is returned.</p>
|
|
1209
|
+
* @public
|
|
1210
1210
|
*/
|
|
1211
1211
|
stageSession?: StageSession;
|
|
1212
1212
|
}
|
|
@@ -1215,8 +1215,8 @@ export interface GetStageSessionResponse {
|
|
|
1215
1215
|
*/
|
|
1216
1216
|
export interface GetStorageConfigurationRequest {
|
|
1217
1217
|
/**
|
|
1218
|
-
* @public
|
|
1219
1218
|
* <p>ARN of the storage configuration to be retrieved.</p>
|
|
1219
|
+
* @public
|
|
1220
1220
|
*/
|
|
1221
1221
|
arn: string | undefined;
|
|
1222
1222
|
}
|
|
@@ -1225,8 +1225,8 @@ export interface GetStorageConfigurationRequest {
|
|
|
1225
1225
|
*/
|
|
1226
1226
|
export interface GetStorageConfigurationResponse {
|
|
1227
1227
|
/**
|
|
1228
|
-
* @public
|
|
1229
1228
|
* <p>The StorageConfiguration that was returned.</p>
|
|
1229
|
+
* @public
|
|
1230
1230
|
*/
|
|
1231
1231
|
storageConfiguration?: StorageConfiguration;
|
|
1232
1232
|
}
|
|
@@ -1235,100 +1235,100 @@ export interface GetStorageConfigurationResponse {
|
|
|
1235
1235
|
*/
|
|
1236
1236
|
export interface ListCompositionsRequest {
|
|
1237
1237
|
/**
|
|
1238
|
-
* @public
|
|
1239
1238
|
* <p>Filters the Composition list to match the specified Stage ARN.</p>
|
|
1239
|
+
* @public
|
|
1240
1240
|
*/
|
|
1241
1241
|
filterByStageArn?: string;
|
|
1242
1242
|
/**
|
|
1243
|
-
* @public
|
|
1244
1243
|
* <p>Filters the Composition list to match the specified EncoderConfiguration attached to at
|
|
1245
1244
|
* least one of its output.</p>
|
|
1245
|
+
* @public
|
|
1246
1246
|
*/
|
|
1247
1247
|
filterByEncoderConfigurationArn?: string;
|
|
1248
1248
|
/**
|
|
1249
|
-
* @public
|
|
1250
1249
|
* <p>The first Composition to retrieve. This is used for pagination; see the
|
|
1251
1250
|
* <code>nextToken</code> response field.</p>
|
|
1251
|
+
* @public
|
|
1252
1252
|
*/
|
|
1253
1253
|
nextToken?: string;
|
|
1254
1254
|
/**
|
|
1255
|
-
* @public
|
|
1256
1255
|
* <p>Maximum number of results to return. Default: 100.</p>
|
|
1256
|
+
* @public
|
|
1257
1257
|
*/
|
|
1258
1258
|
maxResults?: number;
|
|
1259
1259
|
}
|
|
1260
1260
|
/**
|
|
1261
|
-
* @public
|
|
1262
1261
|
* <p>Summary information about a Destination.</p>
|
|
1262
|
+
* @public
|
|
1263
1263
|
*/
|
|
1264
1264
|
export interface DestinationSummary {
|
|
1265
1265
|
/**
|
|
1266
|
-
* @public
|
|
1267
1266
|
* <p>Unique identifier for this destination, assigned by IVS.</p>
|
|
1267
|
+
* @public
|
|
1268
1268
|
*/
|
|
1269
1269
|
id: string | undefined;
|
|
1270
1270
|
/**
|
|
1271
|
-
* @public
|
|
1272
1271
|
* <p>State of the Composition Destination.</p>
|
|
1272
|
+
* @public
|
|
1273
1273
|
*/
|
|
1274
1274
|
state: DestinationState | undefined;
|
|
1275
1275
|
/**
|
|
1276
|
-
* @public
|
|
1277
1276
|
* <p>UTC time of the destination start. This is an ISO 8601 timestamp; <i>note that
|
|
1278
1277
|
* this is returned as a string</i>.</p>
|
|
1278
|
+
* @public
|
|
1279
1279
|
*/
|
|
1280
1280
|
startTime?: Date;
|
|
1281
1281
|
/**
|
|
1282
|
-
* @public
|
|
1283
1282
|
* <p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this
|
|
1284
1283
|
* is returned as a string</i>.</p>
|
|
1284
|
+
* @public
|
|
1285
1285
|
*/
|
|
1286
1286
|
endTime?: Date;
|
|
1287
1287
|
}
|
|
1288
1288
|
/**
|
|
1289
|
-
* @public
|
|
1290
1289
|
* <p>Summary information about a Composition.</p>
|
|
1290
|
+
* @public
|
|
1291
1291
|
*/
|
|
1292
1292
|
export interface CompositionSummary {
|
|
1293
1293
|
/**
|
|
1294
|
-
* @public
|
|
1295
1294
|
* <p>ARN of the Composition resource.</p>
|
|
1295
|
+
* @public
|
|
1296
1296
|
*/
|
|
1297
1297
|
arn: string | undefined;
|
|
1298
1298
|
/**
|
|
1299
|
-
* @public
|
|
1300
1299
|
* <p>ARN of the attached stage.</p>
|
|
1300
|
+
* @public
|
|
1301
1301
|
*/
|
|
1302
1302
|
stageArn: string | undefined;
|
|
1303
1303
|
/**
|
|
1304
|
-
* @public
|
|
1305
1304
|
* <p>Array of Destination objects.</p>
|
|
1305
|
+
* @public
|
|
1306
1306
|
*/
|
|
1307
1307
|
destinations: DestinationSummary[] | undefined;
|
|
1308
1308
|
/**
|
|
1309
|
-
* @public
|
|
1310
1309
|
* <p>State of the Composition resource.</p>
|
|
1310
|
+
* @public
|
|
1311
1311
|
*/
|
|
1312
1312
|
state: CompositionState | undefined;
|
|
1313
1313
|
/**
|
|
1314
|
-
* @public
|
|
1315
1314
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1316
1315
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1317
1316
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1318
1317
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1319
1318
|
* there.</p>
|
|
1319
|
+
* @public
|
|
1320
1320
|
*/
|
|
1321
1321
|
tags?: Record<string, string>;
|
|
1322
1322
|
/**
|
|
1323
|
-
* @public
|
|
1324
1323
|
* <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
|
|
1325
1324
|
* this is returned as a string</i>.</p>
|
|
1325
|
+
* @public
|
|
1326
1326
|
*/
|
|
1327
1327
|
startTime?: Date;
|
|
1328
1328
|
/**
|
|
1329
|
-
* @public
|
|
1330
1329
|
* <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that
|
|
1331
1330
|
* this is returned as a string</i>.</p>
|
|
1331
|
+
* @public
|
|
1332
1332
|
*/
|
|
1333
1333
|
endTime?: Date;
|
|
1334
1334
|
}
|
|
@@ -1337,14 +1337,14 @@ export interface CompositionSummary {
|
|
|
1337
1337
|
*/
|
|
1338
1338
|
export interface ListCompositionsResponse {
|
|
1339
1339
|
/**
|
|
1340
|
-
* @public
|
|
1341
1340
|
* <p>List of the matching Compositions (summary information only).</p>
|
|
1341
|
+
* @public
|
|
1342
1342
|
*/
|
|
1343
1343
|
compositions: CompositionSummary[] | undefined;
|
|
1344
1344
|
/**
|
|
1345
|
-
* @public
|
|
1346
1345
|
* <p>If there are more compositions than <code>maxResults</code>, use <code>nextToken</code>
|
|
1347
1346
|
* in the request to get the next set.</p>
|
|
1347
|
+
* @public
|
|
1348
1348
|
*/
|
|
1349
1349
|
nextToken?: string;
|
|
1350
1350
|
}
|
|
@@ -1353,39 +1353,39 @@ export interface ListCompositionsResponse {
|
|
|
1353
1353
|
*/
|
|
1354
1354
|
export interface ListEncoderConfigurationsRequest {
|
|
1355
1355
|
/**
|
|
1356
|
-
* @public
|
|
1357
1356
|
* <p>The first encoder configuration to retrieve. This is used for pagination; see the
|
|
1358
1357
|
* <code>nextToken</code> response field.</p>
|
|
1358
|
+
* @public
|
|
1359
1359
|
*/
|
|
1360
1360
|
nextToken?: string;
|
|
1361
1361
|
/**
|
|
1362
|
-
* @public
|
|
1363
1362
|
* <p>Maximum number of results to return. Default: 100.</p>
|
|
1363
|
+
* @public
|
|
1364
1364
|
*/
|
|
1365
1365
|
maxResults?: number;
|
|
1366
1366
|
}
|
|
1367
1367
|
/**
|
|
1368
|
-
* @public
|
|
1369
1368
|
* <p>Summary information about an EncoderConfiguration.</p>
|
|
1369
|
+
* @public
|
|
1370
1370
|
*/
|
|
1371
1371
|
export interface EncoderConfigurationSummary {
|
|
1372
1372
|
/**
|
|
1373
|
-
* @public
|
|
1374
1373
|
* <p>ARN of the EncoderConfiguration resource.</p>
|
|
1374
|
+
* @public
|
|
1375
1375
|
*/
|
|
1376
1376
|
arn: string | undefined;
|
|
1377
1377
|
/**
|
|
1378
|
-
* @public
|
|
1379
1378
|
* <p>Optional name to identify the resource.</p>
|
|
1379
|
+
* @public
|
|
1380
1380
|
*/
|
|
1381
1381
|
name?: string;
|
|
1382
1382
|
/**
|
|
1383
|
-
* @public
|
|
1384
1383
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1385
1384
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1386
1385
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1387
1386
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1388
1387
|
* there.</p>
|
|
1388
|
+
* @public
|
|
1389
1389
|
*/
|
|
1390
1390
|
tags?: Record<string, string>;
|
|
1391
1391
|
}
|
|
@@ -1394,14 +1394,14 @@ export interface EncoderConfigurationSummary {
|
|
|
1394
1394
|
*/
|
|
1395
1395
|
export interface ListEncoderConfigurationsResponse {
|
|
1396
1396
|
/**
|
|
1397
|
-
* @public
|
|
1398
1397
|
* <p>List of the matching EncoderConfigurations (summary information only).</p>
|
|
1398
|
+
* @public
|
|
1399
1399
|
*/
|
|
1400
1400
|
encoderConfigurations: EncoderConfigurationSummary[] | undefined;
|
|
1401
1401
|
/**
|
|
1402
|
-
* @public
|
|
1403
1402
|
* <p>If there are more encoder configurations than <code>maxResults</code>, use
|
|
1404
1403
|
* <code>nextToken</code> in the request to get the next set.</p>
|
|
1404
|
+
* @public
|
|
1405
1405
|
*/
|
|
1406
1406
|
nextToken?: string;
|
|
1407
1407
|
}
|
|
@@ -1410,29 +1410,29 @@ export interface ListEncoderConfigurationsResponse {
|
|
|
1410
1410
|
*/
|
|
1411
1411
|
export interface ListParticipantEventsRequest {
|
|
1412
1412
|
/**
|
|
1413
|
-
* @public
|
|
1414
1413
|
* <p>Stage ARN.</p>
|
|
1414
|
+
* @public
|
|
1415
1415
|
*/
|
|
1416
1416
|
stageArn: string | undefined;
|
|
1417
1417
|
/**
|
|
1418
|
-
* @public
|
|
1419
1418
|
* <p>ID of a session within the stage.</p>
|
|
1419
|
+
* @public
|
|
1420
1420
|
*/
|
|
1421
1421
|
sessionId: string | undefined;
|
|
1422
1422
|
/**
|
|
1423
|
-
* @public
|
|
1424
1423
|
* <p>Unique identifier for this participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.</p>
|
|
1424
|
+
* @public
|
|
1425
1425
|
*/
|
|
1426
1426
|
participantId: string | undefined;
|
|
1427
1427
|
/**
|
|
1428
|
-
* @public
|
|
1429
1428
|
* <p>The first participant event to retrieve. This is used for pagination; see the
|
|
1430
1429
|
* <code>nextToken</code> response field.</p>
|
|
1430
|
+
* @public
|
|
1431
1431
|
*/
|
|
1432
1432
|
nextToken?: string;
|
|
1433
1433
|
/**
|
|
1434
|
-
* @public
|
|
1435
1434
|
* <p>Maximum number of results to return. Default: 50.</p>
|
|
1435
|
+
* @public
|
|
1436
1436
|
*/
|
|
1437
1437
|
maxResults?: number;
|
|
1438
1438
|
}
|
|
@@ -1469,34 +1469,33 @@ export declare const EventName: {
|
|
|
1469
1469
|
*/
|
|
1470
1470
|
export type EventName = (typeof EventName)[keyof typeof EventName];
|
|
1471
1471
|
/**
|
|
1472
|
-
* @public
|
|
1473
1472
|
* <p>An occurrence during a stage session.</p>
|
|
1473
|
+
* @public
|
|
1474
1474
|
*/
|
|
1475
1475
|
export interface Event {
|
|
1476
1476
|
/**
|
|
1477
|
-
* @public
|
|
1478
1477
|
* <p>The name of the event.</p>
|
|
1478
|
+
* @public
|
|
1479
1479
|
*/
|
|
1480
1480
|
name?: EventName;
|
|
1481
1481
|
/**
|
|
1482
|
-
* @public
|
|
1483
1482
|
* <p>Unique identifier for the participant who triggered the event. This is assigned by
|
|
1484
1483
|
* IVS.</p>
|
|
1484
|
+
* @public
|
|
1485
1485
|
*/
|
|
1486
1486
|
participantId?: string;
|
|
1487
1487
|
/**
|
|
1488
|
-
* @public
|
|
1489
1488
|
* <p>ISO 8601 timestamp (returned as a string) for when the event occurred.</p>
|
|
1489
|
+
* @public
|
|
1490
1490
|
*/
|
|
1491
1491
|
eventTime?: Date;
|
|
1492
1492
|
/**
|
|
1493
|
-
* @public
|
|
1494
1493
|
* <p>Unique identifier for the remote participant. For a subscribe event, this is the
|
|
1495
1494
|
* publisher. For a publish or join event, this is null. This is assigned by IVS.</p>
|
|
1495
|
+
* @public
|
|
1496
1496
|
*/
|
|
1497
1497
|
remoteParticipantId?: string;
|
|
1498
1498
|
/**
|
|
1499
|
-
* @public
|
|
1500
1499
|
* <p>If the event is an error event, the error code is provided to give insight into the
|
|
1501
1500
|
* specific error that occurred. If the event is not an error event, this field is null.
|
|
1502
1501
|
* <code>INSUFFICIENT_CAPABILITIES</code> indicates that the participant tried to take an
|
|
@@ -1506,6 +1505,7 @@ export interface Event {
|
|
|
1506
1505
|
* information, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">Service Quotas</a>.
|
|
1507
1506
|
* <code>PUBLISHER_NOT_FOUND</code> indicates that the participant tried to subscribe to a
|
|
1508
1507
|
* publisher that doesn’t exist. </p>
|
|
1508
|
+
* @public
|
|
1509
1509
|
*/
|
|
1510
1510
|
errorCode?: EventErrorCode;
|
|
1511
1511
|
}
|
|
@@ -1514,14 +1514,14 @@ export interface Event {
|
|
|
1514
1514
|
*/
|
|
1515
1515
|
export interface ListParticipantEventsResponse {
|
|
1516
1516
|
/**
|
|
1517
|
-
* @public
|
|
1518
1517
|
* <p>List of the matching events.</p>
|
|
1518
|
+
* @public
|
|
1519
1519
|
*/
|
|
1520
1520
|
events: Event[] | undefined;
|
|
1521
1521
|
/**
|
|
1522
|
-
* @public
|
|
1523
1522
|
* <p>If there are more events than <code>maxResults</code>, use <code>nextToken</code> in the
|
|
1524
1523
|
* request to get the next set. </p>
|
|
1524
|
+
* @public
|
|
1525
1525
|
*/
|
|
1526
1526
|
nextToken?: string;
|
|
1527
1527
|
}
|
|
@@ -1530,82 +1530,82 @@ export interface ListParticipantEventsResponse {
|
|
|
1530
1530
|
*/
|
|
1531
1531
|
export interface ListParticipantsRequest {
|
|
1532
1532
|
/**
|
|
1533
|
-
* @public
|
|
1534
1533
|
* <p>Stage ARN.</p>
|
|
1534
|
+
* @public
|
|
1535
1535
|
*/
|
|
1536
1536
|
stageArn: string | undefined;
|
|
1537
1537
|
/**
|
|
1538
|
-
* @public
|
|
1539
1538
|
* <p>ID of the session within the stage.</p>
|
|
1539
|
+
* @public
|
|
1540
1540
|
*/
|
|
1541
1541
|
sessionId: string | undefined;
|
|
1542
1542
|
/**
|
|
1543
|
-
* @public
|
|
1544
1543
|
* <p>Filters the response list to match the specified user ID. Only one of
|
|
1545
1544
|
* <code>filterByUserId</code>, <code>filterByPublished</code>, or
|
|
1546
1545
|
* <code>filterByState</code> can be provided per request. A <code>userId</code> is a
|
|
1547
1546
|
* customer-assigned name to help identify the token; this can be used to link a participant
|
|
1548
1547
|
* to a user in the customer’s own systems.</p>
|
|
1548
|
+
* @public
|
|
1549
1549
|
*/
|
|
1550
1550
|
filterByUserId?: string;
|
|
1551
1551
|
/**
|
|
1552
|
-
* @public
|
|
1553
1552
|
* <p>Filters the response list to only show participants who published during the stage
|
|
1554
1553
|
* session. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or
|
|
1555
1554
|
* <code>filterByState</code> can be provided per request.</p>
|
|
1555
|
+
* @public
|
|
1556
1556
|
*/
|
|
1557
1557
|
filterByPublished?: boolean;
|
|
1558
1558
|
/**
|
|
1559
|
-
* @public
|
|
1560
1559
|
* <p>Filters the response list to only show participants in the specified state. Only one of
|
|
1561
1560
|
* <code>filterByUserId</code>, <code>filterByPublished</code>, or
|
|
1562
1561
|
* <code>filterByState</code> can be provided per request.</p>
|
|
1562
|
+
* @public
|
|
1563
1563
|
*/
|
|
1564
1564
|
filterByState?: ParticipantState;
|
|
1565
1565
|
/**
|
|
1566
|
-
* @public
|
|
1567
1566
|
* <p>The first participant to retrieve. This is used for pagination; see the
|
|
1568
1567
|
* <code>nextToken</code> response field.</p>
|
|
1568
|
+
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
nextToken?: string;
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>Maximum number of results to return. Default: 50.</p>
|
|
1573
|
+
* @public
|
|
1574
1574
|
*/
|
|
1575
1575
|
maxResults?: number;
|
|
1576
1576
|
}
|
|
1577
1577
|
/**
|
|
1578
|
-
* @public
|
|
1579
1578
|
* <p>Summary object describing a participant that has joined a stage.</p>
|
|
1579
|
+
* @public
|
|
1580
1580
|
*/
|
|
1581
1581
|
export interface ParticipantSummary {
|
|
1582
1582
|
/**
|
|
1583
|
-
* @public
|
|
1584
1583
|
* <p>Unique identifier for this participant, assigned by IVS.</p>
|
|
1584
|
+
* @public
|
|
1585
1585
|
*/
|
|
1586
1586
|
participantId?: string;
|
|
1587
1587
|
/**
|
|
1588
|
-
* @public
|
|
1589
1588
|
* <p>Customer-assigned name to help identify the token; this can be used to link a
|
|
1590
1589
|
* participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
|
|
1591
1590
|
* <i>This field is exposed to all stage participants and should not be used for
|
|
1592
1591
|
* personally identifying, confidential, or sensitive information</i>.</p>
|
|
1592
|
+
* @public
|
|
1593
1593
|
*/
|
|
1594
1594
|
userId?: string;
|
|
1595
1595
|
/**
|
|
1596
|
-
* @public
|
|
1597
1596
|
* <p>Whether the participant is connected to or disconnected from the stage.</p>
|
|
1597
|
+
* @public
|
|
1598
1598
|
*/
|
|
1599
1599
|
state?: ParticipantState;
|
|
1600
1600
|
/**
|
|
1601
|
-
* @public
|
|
1602
1601
|
* <p>ISO 8601 timestamp (returned as a string) when the participant first joined the stage
|
|
1603
1602
|
* session.</p>
|
|
1603
|
+
* @public
|
|
1604
1604
|
*/
|
|
1605
1605
|
firstJoinTime?: Date;
|
|
1606
1606
|
/**
|
|
1607
|
-
* @public
|
|
1608
1607
|
* <p>Whether the participant ever published to the stage session.</p>
|
|
1608
|
+
* @public
|
|
1609
1609
|
*/
|
|
1610
1610
|
published?: boolean;
|
|
1611
1611
|
}
|
|
@@ -1614,14 +1614,14 @@ export interface ParticipantSummary {
|
|
|
1614
1614
|
*/
|
|
1615
1615
|
export interface ListParticipantsResponse {
|
|
1616
1616
|
/**
|
|
1617
|
-
* @public
|
|
1618
1617
|
* <p>List of the matching participants (summary information only).</p>
|
|
1618
|
+
* @public
|
|
1619
1619
|
*/
|
|
1620
1620
|
participants: ParticipantSummary[] | undefined;
|
|
1621
1621
|
/**
|
|
1622
|
-
* @public
|
|
1623
1622
|
* <p>If there are more participants than <code>maxResults</code>, use <code>nextToken</code>
|
|
1624
1623
|
* in the request to get the next set.</p>
|
|
1624
|
+
* @public
|
|
1625
1625
|
*/
|
|
1626
1626
|
nextToken?: string;
|
|
1627
1627
|
}
|
|
@@ -1630,44 +1630,44 @@ export interface ListParticipantsResponse {
|
|
|
1630
1630
|
*/
|
|
1631
1631
|
export interface ListStagesRequest {
|
|
1632
1632
|
/**
|
|
1633
|
-
* @public
|
|
1634
1633
|
* <p>The first stage to retrieve. This is used for pagination; see the <code>nextToken</code>
|
|
1635
1634
|
* response field.</p>
|
|
1635
|
+
* @public
|
|
1636
1636
|
*/
|
|
1637
1637
|
nextToken?: string;
|
|
1638
1638
|
/**
|
|
1639
|
-
* @public
|
|
1640
1639
|
* <p>Maximum number of results to return. Default: 50.</p>
|
|
1640
|
+
* @public
|
|
1641
1641
|
*/
|
|
1642
1642
|
maxResults?: number;
|
|
1643
1643
|
}
|
|
1644
1644
|
/**
|
|
1645
|
-
* @public
|
|
1646
1645
|
* <p>Summary information about a stage.</p>
|
|
1646
|
+
* @public
|
|
1647
1647
|
*/
|
|
1648
1648
|
export interface StageSummary {
|
|
1649
1649
|
/**
|
|
1650
|
-
* @public
|
|
1651
1650
|
* <p>Stage ARN.</p>
|
|
1651
|
+
* @public
|
|
1652
1652
|
*/
|
|
1653
1653
|
arn: string | undefined;
|
|
1654
1654
|
/**
|
|
1655
|
-
* @public
|
|
1656
1655
|
* <p>Stage name.</p>
|
|
1656
|
+
* @public
|
|
1657
1657
|
*/
|
|
1658
1658
|
name?: string;
|
|
1659
1659
|
/**
|
|
1660
|
-
* @public
|
|
1661
1660
|
* <p>ID of the active session within the stage.</p>
|
|
1661
|
+
* @public
|
|
1662
1662
|
*/
|
|
1663
1663
|
activeSessionId?: string;
|
|
1664
1664
|
/**
|
|
1665
|
-
* @public
|
|
1666
1665
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1667
1666
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1668
1667
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1669
1668
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1670
1669
|
* there.</p>
|
|
1670
|
+
* @public
|
|
1671
1671
|
*/
|
|
1672
1672
|
tags?: Record<string, string>;
|
|
1673
1673
|
}
|
|
@@ -1676,14 +1676,14 @@ export interface StageSummary {
|
|
|
1676
1676
|
*/
|
|
1677
1677
|
export interface ListStagesResponse {
|
|
1678
1678
|
/**
|
|
1679
|
-
* @public
|
|
1680
1679
|
* <p>List of the matching stages (summary information only).</p>
|
|
1680
|
+
* @public
|
|
1681
1681
|
*/
|
|
1682
1682
|
stages: StageSummary[] | undefined;
|
|
1683
1683
|
/**
|
|
1684
|
-
* @public
|
|
1685
1684
|
* <p>If there are more stages than <code>maxResults</code>, use <code>nextToken</code> in the
|
|
1686
1685
|
* request to get the next set.</p>
|
|
1686
|
+
* @public
|
|
1687
1687
|
*/
|
|
1688
1688
|
nextToken?: string;
|
|
1689
1689
|
}
|
|
@@ -1692,41 +1692,41 @@ export interface ListStagesResponse {
|
|
|
1692
1692
|
*/
|
|
1693
1693
|
export interface ListStageSessionsRequest {
|
|
1694
1694
|
/**
|
|
1695
|
-
* @public
|
|
1696
1695
|
* <p>Stage ARN.</p>
|
|
1696
|
+
* @public
|
|
1697
1697
|
*/
|
|
1698
1698
|
stageArn: string | undefined;
|
|
1699
1699
|
/**
|
|
1700
|
-
* @public
|
|
1701
1700
|
* <p>The first stage session to retrieve. This is used for pagination; see the
|
|
1702
1701
|
* <code>nextToken</code> response field.</p>
|
|
1702
|
+
* @public
|
|
1703
1703
|
*/
|
|
1704
1704
|
nextToken?: string;
|
|
1705
1705
|
/**
|
|
1706
|
-
* @public
|
|
1707
1706
|
* <p>Maximum number of results to return. Default: 50.</p>
|
|
1707
|
+
* @public
|
|
1708
1708
|
*/
|
|
1709
1709
|
maxResults?: number;
|
|
1710
1710
|
}
|
|
1711
1711
|
/**
|
|
1712
|
-
* @public
|
|
1713
1712
|
* <p>Summary information about a stage session.</p>
|
|
1713
|
+
* @public
|
|
1714
1714
|
*/
|
|
1715
1715
|
export interface StageSessionSummary {
|
|
1716
1716
|
/**
|
|
1717
|
-
* @public
|
|
1718
1717
|
* <p>ID of the session within the stage.</p>
|
|
1718
|
+
* @public
|
|
1719
1719
|
*/
|
|
1720
1720
|
sessionId?: string;
|
|
1721
1721
|
/**
|
|
1722
|
-
* @public
|
|
1723
1722
|
* <p> ISO 8601 timestamp (returned as a string) when this stage session began.</p>
|
|
1723
|
+
* @public
|
|
1724
1724
|
*/
|
|
1725
1725
|
startTime?: Date;
|
|
1726
1726
|
/**
|
|
1727
|
-
* @public
|
|
1728
1727
|
* <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if
|
|
1729
1728
|
* the stage is active.</p>
|
|
1729
|
+
* @public
|
|
1730
1730
|
*/
|
|
1731
1731
|
endTime?: Date;
|
|
1732
1732
|
}
|
|
@@ -1735,14 +1735,14 @@ export interface StageSessionSummary {
|
|
|
1735
1735
|
*/
|
|
1736
1736
|
export interface ListStageSessionsResponse {
|
|
1737
1737
|
/**
|
|
1738
|
-
* @public
|
|
1739
1738
|
* <p>List of matching stage sessions.</p>
|
|
1739
|
+
* @public
|
|
1740
1740
|
*/
|
|
1741
1741
|
stageSessions: StageSessionSummary[] | undefined;
|
|
1742
1742
|
/**
|
|
1743
|
-
* @public
|
|
1744
1743
|
* <p>If there are more stage sessions than <code>maxResults</code>, use
|
|
1745
1744
|
* <code>nextToken</code> in the request to get the next set.</p>
|
|
1745
|
+
* @public
|
|
1746
1746
|
*/
|
|
1747
1747
|
nextToken?: string;
|
|
1748
1748
|
}
|
|
@@ -1751,45 +1751,45 @@ export interface ListStageSessionsResponse {
|
|
|
1751
1751
|
*/
|
|
1752
1752
|
export interface ListStorageConfigurationsRequest {
|
|
1753
1753
|
/**
|
|
1754
|
-
* @public
|
|
1755
1754
|
* <p>The first storage configuration to retrieve. This is used for pagination;
|
|
1756
1755
|
* see the <code>nextToken</code> response field.</p>
|
|
1756
|
+
* @public
|
|
1757
1757
|
*/
|
|
1758
1758
|
nextToken?: string;
|
|
1759
1759
|
/**
|
|
1760
|
-
* @public
|
|
1761
1760
|
* <p>Maximum number of storage configurations to return. Default: your service quota or 100,
|
|
1762
1761
|
* whichever is smaller.</p>
|
|
1762
|
+
* @public
|
|
1763
1763
|
*/
|
|
1764
1764
|
maxResults?: number;
|
|
1765
1765
|
}
|
|
1766
1766
|
/**
|
|
1767
|
-
* @public
|
|
1768
1767
|
* <p>Summary information about a storage configuration.</p>
|
|
1768
|
+
* @public
|
|
1769
1769
|
*/
|
|
1770
1770
|
export interface StorageConfigurationSummary {
|
|
1771
1771
|
/**
|
|
1772
|
-
* @public
|
|
1773
1772
|
* <p>ARN of the storage configuration.</p>
|
|
1773
|
+
* @public
|
|
1774
1774
|
*/
|
|
1775
1775
|
arn: string | undefined;
|
|
1776
1776
|
/**
|
|
1777
|
-
* @public
|
|
1778
1777
|
* <p>Name of the storage configuration.</p>
|
|
1778
|
+
* @public
|
|
1779
1779
|
*/
|
|
1780
1780
|
name?: string;
|
|
1781
1781
|
/**
|
|
1782
|
-
* @public
|
|
1783
1782
|
* <p>An S3 destination configuration where recorded videos will be stored.</p>
|
|
1783
|
+
* @public
|
|
1784
1784
|
*/
|
|
1785
1785
|
s3?: S3StorageConfiguration;
|
|
1786
1786
|
/**
|
|
1787
|
-
* @public
|
|
1788
1787
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1789
1788
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1790
1789
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1791
1790
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1792
1791
|
* there.</p>
|
|
1792
|
+
* @public
|
|
1793
1793
|
*/
|
|
1794
1794
|
tags?: Record<string, string>;
|
|
1795
1795
|
}
|
|
@@ -1798,14 +1798,14 @@ export interface StorageConfigurationSummary {
|
|
|
1798
1798
|
*/
|
|
1799
1799
|
export interface ListStorageConfigurationsResponse {
|
|
1800
1800
|
/**
|
|
1801
|
-
* @public
|
|
1802
1801
|
* <p>List of the matching storage configurations.</p>
|
|
1802
|
+
* @public
|
|
1803
1803
|
*/
|
|
1804
1804
|
storageConfigurations: StorageConfigurationSummary[] | undefined;
|
|
1805
1805
|
/**
|
|
1806
|
-
* @public
|
|
1807
1806
|
* <p>If there are more storage configurations than <code>maxResults</code>, use <code>nextToken</code>
|
|
1808
1807
|
* in the request to get the next set.</p>
|
|
1808
|
+
* @public
|
|
1809
1809
|
*/
|
|
1810
1810
|
nextToken?: string;
|
|
1811
1811
|
}
|
|
@@ -1814,8 +1814,8 @@ export interface ListStorageConfigurationsResponse {
|
|
|
1814
1814
|
*/
|
|
1815
1815
|
export interface ListTagsForResourceRequest {
|
|
1816
1816
|
/**
|
|
1817
|
-
* @public
|
|
1818
1817
|
* <p>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</p>
|
|
1818
|
+
* @public
|
|
1819
1819
|
*/
|
|
1820
1820
|
resourceArn: string | undefined;
|
|
1821
1821
|
}
|
|
@@ -1824,9 +1824,9 @@ export interface ListTagsForResourceRequest {
|
|
|
1824
1824
|
*/
|
|
1825
1825
|
export interface ListTagsForResourceResponse {
|
|
1826
1826
|
/**
|
|
1827
|
-
* @public
|
|
1828
1827
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1829
1828
|
* (key:value)</code>.</p>
|
|
1829
|
+
* @public
|
|
1830
1830
|
*/
|
|
1831
1831
|
tags: Record<string, string> | undefined;
|
|
1832
1832
|
}
|
|
@@ -1835,32 +1835,32 @@ export interface ListTagsForResourceResponse {
|
|
|
1835
1835
|
*/
|
|
1836
1836
|
export interface StartCompositionRequest {
|
|
1837
1837
|
/**
|
|
1838
|
-
* @public
|
|
1839
1838
|
* <p>ARN of the stage to be used for compositing.</p>
|
|
1839
|
+
* @public
|
|
1840
1840
|
*/
|
|
1841
1841
|
stageArn: string | undefined;
|
|
1842
1842
|
/**
|
|
1843
|
-
* @public
|
|
1844
1843
|
* <p>Idempotency token.</p>
|
|
1844
|
+
* @public
|
|
1845
1845
|
*/
|
|
1846
1846
|
idempotencyToken?: string;
|
|
1847
1847
|
/**
|
|
1848
|
-
* @public
|
|
1849
1848
|
* <p>Layout object to configure composition parameters.</p>
|
|
1849
|
+
* @public
|
|
1850
1850
|
*/
|
|
1851
1851
|
layout?: LayoutConfiguration;
|
|
1852
1852
|
/**
|
|
1853
|
-
* @public
|
|
1854
1853
|
* <p>Array of destination configuration.</p>
|
|
1854
|
+
* @public
|
|
1855
1855
|
*/
|
|
1856
1856
|
destinations: DestinationConfiguration[] | undefined;
|
|
1857
1857
|
/**
|
|
1858
|
-
* @public
|
|
1859
1858
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1860
1859
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1861
1860
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1862
1861
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1863
1862
|
* there.</p>
|
|
1863
|
+
* @public
|
|
1864
1864
|
*/
|
|
1865
1865
|
tags?: Record<string, string>;
|
|
1866
1866
|
}
|
|
@@ -1869,8 +1869,8 @@ export interface StartCompositionRequest {
|
|
|
1869
1869
|
*/
|
|
1870
1870
|
export interface StartCompositionResponse {
|
|
1871
1871
|
/**
|
|
1872
|
-
* @public
|
|
1873
1872
|
* <p>The Composition that was created.</p>
|
|
1873
|
+
* @public
|
|
1874
1874
|
*/
|
|
1875
1875
|
composition?: Composition;
|
|
1876
1876
|
}
|
|
@@ -1879,8 +1879,8 @@ export interface StartCompositionResponse {
|
|
|
1879
1879
|
*/
|
|
1880
1880
|
export interface StopCompositionRequest {
|
|
1881
1881
|
/**
|
|
1882
|
-
* @public
|
|
1883
1882
|
* <p>ARN of the Composition.</p>
|
|
1883
|
+
* @public
|
|
1884
1884
|
*/
|
|
1885
1885
|
arn: string | undefined;
|
|
1886
1886
|
}
|
|
@@ -1894,17 +1894,17 @@ export interface StopCompositionResponse {
|
|
|
1894
1894
|
*/
|
|
1895
1895
|
export interface TagResourceRequest {
|
|
1896
1896
|
/**
|
|
1897
|
-
* @public
|
|
1898
1897
|
* <p>The ARN of the resource to be tagged. The ARN must be URL-encoded.</p>
|
|
1898
|
+
* @public
|
|
1899
1899
|
*/
|
|
1900
1900
|
resourceArn: string | undefined;
|
|
1901
1901
|
/**
|
|
1902
|
-
* @public
|
|
1903
1902
|
* <p>Array of tags to be added or updated. Array of maps, each of the form
|
|
1904
1903
|
* <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1905
1904
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1906
1905
|
* limits and requirements"; Amazon IVS has no constraints beyond what is documented
|
|
1907
1906
|
* there.</p>
|
|
1907
|
+
* @public
|
|
1908
1908
|
*/
|
|
1909
1909
|
tags: Record<string, string> | undefined;
|
|
1910
1910
|
}
|
|
@@ -1918,17 +1918,17 @@ export interface TagResourceResponse {
|
|
|
1918
1918
|
*/
|
|
1919
1919
|
export interface UntagResourceRequest {
|
|
1920
1920
|
/**
|
|
1921
|
-
* @public
|
|
1922
1921
|
* <p>The ARN of the resource to be untagged. The ARN must be URL-encoded.</p>
|
|
1922
|
+
* @public
|
|
1923
1923
|
*/
|
|
1924
1924
|
resourceArn: string | undefined;
|
|
1925
1925
|
/**
|
|
1926
|
-
* @public
|
|
1927
1926
|
* <p>Array of tags to be removed. Array of maps, each of the form <code>string:string
|
|
1928
1927
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1929
1928
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1930
1929
|
* limits and requirements"; Amazon IVS has no constraints beyond what is documented
|
|
1931
1930
|
* there.</p>
|
|
1931
|
+
* @public
|
|
1932
1932
|
*/
|
|
1933
1933
|
tagKeys: string[] | undefined;
|
|
1934
1934
|
}
|
|
@@ -1942,13 +1942,13 @@ export interface UntagResourceResponse {
|
|
|
1942
1942
|
*/
|
|
1943
1943
|
export interface UpdateStageRequest {
|
|
1944
1944
|
/**
|
|
1945
|
-
* @public
|
|
1946
1945
|
* <p>ARN of the stage to be updated.</p>
|
|
1946
|
+
* @public
|
|
1947
1947
|
*/
|
|
1948
1948
|
arn: string | undefined;
|
|
1949
1949
|
/**
|
|
1950
|
-
* @public
|
|
1951
1950
|
* <p>Name of the stage to be updated.</p>
|
|
1951
|
+
* @public
|
|
1952
1952
|
*/
|
|
1953
1953
|
name?: string;
|
|
1954
1954
|
}
|
|
@@ -1957,8 +1957,8 @@ export interface UpdateStageRequest {
|
|
|
1957
1957
|
*/
|
|
1958
1958
|
export interface UpdateStageResponse {
|
|
1959
1959
|
/**
|
|
1960
|
-
* @public
|
|
1961
1960
|
* <p>The updated stage.</p>
|
|
1961
|
+
* @public
|
|
1962
1962
|
*/
|
|
1963
1963
|
stage?: Stage;
|
|
1964
1964
|
}
|