@aws-sdk/client-ivs-realtime 3.529.1 → 3.535.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/dist-cjs/index.js +29 -0
  2. package/dist-es/models/models_0.js +21 -0
  3. package/dist-types/IVSRealTime.d.ts +7 -1
  4. package/dist-types/IVSRealTimeClient.d.ts +1 -1
  5. package/dist-types/commands/CreateEncoderConfigurationCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateParticipantTokenCommand.d.ts +2 -1
  7. package/dist-types/commands/CreateStageCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateStorageConfigurationCommand.d.ts +2 -1
  9. package/dist-types/commands/DeleteEncoderConfigurationCommand.d.ts +2 -1
  10. package/dist-types/commands/DeleteStageCommand.d.ts +2 -1
  11. package/dist-types/commands/DeleteStorageConfigurationCommand.d.ts +2 -1
  12. package/dist-types/commands/DisconnectParticipantCommand.d.ts +2 -1
  13. package/dist-types/commands/GetCompositionCommand.d.ts +18 -1
  14. package/dist-types/commands/GetEncoderConfigurationCommand.d.ts +2 -1
  15. package/dist-types/commands/GetParticipantCommand.d.ts +2 -1
  16. package/dist-types/commands/GetStageCommand.d.ts +2 -1
  17. package/dist-types/commands/GetStageSessionCommand.d.ts +2 -1
  18. package/dist-types/commands/GetStorageConfigurationCommand.d.ts +2 -1
  19. package/dist-types/commands/ListCompositionsCommand.d.ts +2 -1
  20. package/dist-types/commands/ListEncoderConfigurationsCommand.d.ts +2 -1
  21. package/dist-types/commands/ListParticipantEventsCommand.d.ts +2 -1
  22. package/dist-types/commands/ListParticipantsCommand.d.ts +2 -1
  23. package/dist-types/commands/ListStageSessionsCommand.d.ts +2 -1
  24. package/dist-types/commands/ListStagesCommand.d.ts +2 -1
  25. package/dist-types/commands/ListStorageConfigurationsCommand.d.ts +2 -1
  26. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  27. package/dist-types/commands/StartCompositionCommand.d.ts +34 -1
  28. package/dist-types/commands/StopCompositionCommand.d.ts +2 -1
  29. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  30. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  31. package/dist-types/commands/UpdateStageCommand.d.ts +2 -1
  32. package/dist-types/models/models_0.d.ts +387 -239
  33. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  34. package/dist-types/runtimeConfig.d.ts +2 -2
  35. package/dist-types/runtimeConfig.native.d.ts +2 -2
  36. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  37. package/dist-types/ts3.4/IVSRealTime.d.ts +6 -0
  38. package/dist-types/ts3.4/commands/CreateEncoderConfigurationCommand.d.ts +9 -0
  39. package/dist-types/ts3.4/commands/CreateParticipantTokenCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/CreateStageCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/CreateStorageConfigurationCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/DeleteEncoderConfigurationCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/DeleteStageCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/DeleteStorageConfigurationCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/DisconnectParticipantCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/GetCompositionCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/GetEncoderConfigurationCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/GetParticipantCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/GetStageCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/GetStageSessionCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/GetStorageConfigurationCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/ListCompositionsCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/ListEncoderConfigurationsCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/ListParticipantEventsCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/ListParticipantsCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/ListStageSessionsCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/ListStagesCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/ListStorageConfigurationsCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/StartCompositionCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/StopCompositionCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/UpdateStageCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/models/models_0.d.ts +43 -0
  66. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  67. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  68. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  69. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  70. 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,68 +716,216 @@ 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
  }
756
756
  /**
757
757
  * @public
758
+ * @enum
759
+ */
760
+ export declare const VideoAspectRatio: {
761
+ readonly AUTO: "AUTO";
762
+ readonly PORTRAIT: "PORTRAIT";
763
+ readonly SQUARE: "SQUARE";
764
+ readonly VIDEO: "VIDEO";
765
+ };
766
+ /**
767
+ * @public
768
+ */
769
+ export type VideoAspectRatio = (typeof VideoAspectRatio)[keyof typeof VideoAspectRatio];
770
+ /**
771
+ * @public
772
+ * @enum
773
+ */
774
+ export declare const VideoFillMode: {
775
+ readonly CONTAIN: "CONTAIN";
776
+ readonly COVER: "COVER";
777
+ readonly FILL: "FILL";
778
+ };
779
+ /**
780
+ * @public
781
+ */
782
+ export type VideoFillMode = (typeof VideoFillMode)[keyof typeof VideoFillMode];
783
+ /**
758
784
  * <p>Configuration information specific to Grid layout, for server-side composition. See
759
785
  * "Layouts" in <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html">Server-Side
760
786
  * Composition</a>.</p>
787
+ * @public
761
788
  */
762
789
  export interface GridConfiguration {
763
790
  /**
764
- * @public
765
791
  * <p>This attribute name identifies the featured slot. A participant with this attribute set
766
792
  * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured
767
793
  * slot.</p>
794
+ * @public
768
795
  */
769
796
  featuredParticipantAttribute?: string;
797
+ /**
798
+ * <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
799
+ * @public
800
+ */
801
+ omitStoppedVideo?: boolean;
802
+ /**
803
+ * <p>Sets the non-featured participant display mode. Default: <code>VIDEO</code>.</p>
804
+ * @public
805
+ */
806
+ videoAspectRatio?: VideoAspectRatio;
807
+ /**
808
+ * <p>Defines how video fits within the participant tile. When not set,
809
+ * <code>videoFillMode</code> defaults to <code>COVER</code> fill mode for participants in the grid
810
+ * and to <code>CONTAIN</code> fill mode for featured participants.</p>
811
+ * @public
812
+ */
813
+ videoFillMode?: VideoFillMode;
814
+ /**
815
+ * <p>Specifies the spacing between participant tiles in pixels. Default: <code>2</code>.</p>
816
+ * @public
817
+ */
818
+ gridGap?: number;
770
819
  }
771
820
  /**
772
821
  * @public
822
+ * @enum
823
+ */
824
+ export declare const PipBehavior: {
825
+ readonly DYNAMIC: "DYNAMIC";
826
+ readonly STATIC: "STATIC";
827
+ };
828
+ /**
829
+ * @public
830
+ */
831
+ export type PipBehavior = (typeof PipBehavior)[keyof typeof PipBehavior];
832
+ /**
833
+ * @public
834
+ * @enum
835
+ */
836
+ export declare const PipPosition: {
837
+ readonly BOTTOM_LEFT: "BOTTOM_LEFT";
838
+ readonly BOTTOM_RIGHT: "BOTTOM_RIGHT";
839
+ readonly TOP_LEFT: "TOP_LEFT";
840
+ readonly TOP_RIGHT: "TOP_RIGHT";
841
+ };
842
+ /**
843
+ * @public
844
+ */
845
+ export type PipPosition = (typeof PipPosition)[keyof typeof PipPosition];
846
+ /**
847
+ * <p>Configuration information specific to Picture-in-Picture (PiP) layout,
848
+ * for <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html">server-side composition</a>.
849
+ * </p>
850
+ * @public
851
+ */
852
+ export interface PipConfiguration {
853
+ /**
854
+ * <p>This attribute name identifies the featured slot. A participant with this attribute set
855
+ * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured
856
+ * slot.</p>
857
+ * @public
858
+ */
859
+ featuredParticipantAttribute?: string;
860
+ /**
861
+ * <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
862
+ * @public
863
+ */
864
+ omitStoppedVideo?: boolean;
865
+ /**
866
+ * <p>Defines how video fits within the participant tile. Default: <code>COVER</code>.
867
+ * </p>
868
+ * @public
869
+ */
870
+ videoFillMode?: VideoFillMode;
871
+ /**
872
+ * <p>Specifies the spacing between participant tiles in pixels. Default: <code>0</code>.</p>
873
+ * @public
874
+ */
875
+ gridGap?: number;
876
+ /**
877
+ * <p>Identifies the PiP slot. A participant with this attribute set
878
+ * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a>
879
+ * is placed in the PiP slot.</p>
880
+ * @public
881
+ */
882
+ pipParticipantAttribute?: string;
883
+ /**
884
+ * <p>Defines PiP behavior when all participants have left. Default: <code>STATIC</code>.</p>
885
+ * @public
886
+ */
887
+ pipBehavior?: PipBehavior;
888
+ /**
889
+ * <p>Sets the PiP window’s offset position in pixels from the closest edges determined by <code>PipPosition</code>.
890
+ * Default: <code>0</code>.</p>
891
+ * @public
892
+ */
893
+ pipOffset?: number;
894
+ /**
895
+ * <p>Determines the corner position of the PiP window. Default: <code>BOTTOM_RIGHT</code>.</p>
896
+ * @public
897
+ */
898
+ pipPosition?: PipPosition;
899
+ /**
900
+ * <p>Specifies the width of the PiP window in pixels. When this is not set explicitly,
901
+ * <code>pipWidth</code>’s value will be based on the size of the composition and the
902
+ * aspect ratio of the participant’s video.</p>
903
+ * @public
904
+ */
905
+ pipWidth?: number;
906
+ /**
907
+ * <p>Specifies the height of the PiP window in pixels. When this is not set explicitly,
908
+ * <code>pipHeight</code>’s value will be based on the size of the composition and the
909
+ * aspect ratio of the participant’s video.</p>
910
+ * @public
911
+ */
912
+ pipHeight?: number;
913
+ }
914
+ /**
773
915
  * <p>Configuration information of supported layouts for server-side composition.</p>
916
+ * @public
774
917
  */
775
918
  export interface LayoutConfiguration {
776
919
  /**
777
- * @public
778
920
  * <p>Configuration related to grid layout. Default: Grid layout.</p>
921
+ * @public
779
922
  */
780
923
  grid?: GridConfiguration;
924
+ /**
925
+ * <p>Configuration related to PiP layout.</p>
926
+ * @public
927
+ */
928
+ pip?: PipConfiguration;
781
929
  }
782
930
  /**
783
931
  * @public
@@ -795,55 +943,55 @@ export declare const CompositionState: {
795
943
  */
796
944
  export type CompositionState = (typeof CompositionState)[keyof typeof CompositionState];
797
945
  /**
798
- * @public
799
946
  * <p>Object specifying a Composition resource.</p>
947
+ * @public
800
948
  */
801
949
  export interface Composition {
802
950
  /**
803
- * @public
804
951
  * <p>ARN of the Composition resource.</p>
952
+ * @public
805
953
  */
806
954
  arn: string | undefined;
807
955
  /**
808
- * @public
809
956
  * <p>ARN of the stage used as input</p>
957
+ * @public
810
958
  */
811
959
  stageArn: string | undefined;
812
960
  /**
813
- * @public
814
961
  * <p>State of the Composition.</p>
962
+ * @public
815
963
  */
816
964
  state: CompositionState | undefined;
817
965
  /**
818
- * @public
819
966
  * <p>Layout object to configure composition parameters.</p>
967
+ * @public
820
968
  */
821
969
  layout: LayoutConfiguration | undefined;
822
970
  /**
823
- * @public
824
971
  * <p>Array of Destination objects. A Composition can contain either one destination
825
972
  * (<code>channel</code> or <code>s3</code>) or two (one <code>channel</code> and one <code>s3</code>).</p>
973
+ * @public
826
974
  */
827
975
  destinations: Destination[] | undefined;
828
976
  /**
829
- * @public
830
977
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
831
978
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
832
979
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
833
980
  * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
834
981
  * there.</p>
982
+ * @public
835
983
  */
836
984
  tags?: Record<string, string>;
837
985
  /**
838
- * @public
839
986
  * <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
840
987
  * this is returned as a string</i>.</p>
988
+ * @public
841
989
  */
842
990
  startTime?: Date;
843
991
  /**
844
- * @public
845
992
  * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that
846
993
  * this is returned as a string</i>.</p>
994
+ * @public
847
995
  */
848
996
  endTime?: Date;
849
997
  }
@@ -852,8 +1000,8 @@ export interface Composition {
852
1000
  */
853
1001
  export interface GetCompositionResponse {
854
1002
  /**
855
- * @public
856
1003
  * <p>The Composition that was returned.</p>
1004
+ * @public
857
1005
  */
858
1006
  composition?: Composition;
859
1007
  }
@@ -862,8 +1010,8 @@ export interface GetCompositionResponse {
862
1010
  */
863
1011
  export interface GetEncoderConfigurationRequest {
864
1012
  /**
865
- * @public
866
1013
  * <p>ARN of the EncoderConfiguration resource.</p>
1014
+ * @public
867
1015
  */
868
1016
  arn: string | undefined;
869
1017
  }
@@ -872,8 +1020,8 @@ export interface GetEncoderConfigurationRequest {
872
1020
  */
873
1021
  export interface GetEncoderConfigurationResponse {
874
1022
  /**
875
- * @public
876
1023
  * <p>The EncoderConfiguration that was returned.</p>
1024
+ * @public
877
1025
  */
878
1026
  encoderConfiguration?: EncoderConfiguration;
879
1027
  }
@@ -882,18 +1030,18 @@ export interface GetEncoderConfigurationResponse {
882
1030
  */
883
1031
  export interface GetParticipantRequest {
884
1032
  /**
885
- * @public
886
1033
  * <p>Stage ARN.</p>
1034
+ * @public
887
1035
  */
888
1036
  stageArn: string | undefined;
889
1037
  /**
890
- * @public
891
1038
  * <p>ID of a session within the stage.</p>
1039
+ * @public
892
1040
  */
893
1041
  sessionId: string | undefined;
894
1042
  /**
895
- * @public
896
1043
  * <p>Unique identifier for the participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.</p>
1044
+ * @public
897
1045
  */
898
1046
  participantId: string | undefined;
899
1047
  }
@@ -910,75 +1058,75 @@ export declare const ParticipantState: {
910
1058
  */
911
1059
  export type ParticipantState = (typeof ParticipantState)[keyof typeof ParticipantState];
912
1060
  /**
913
- * @public
914
1061
  * <p>Object describing a participant that has joined a stage.</p>
1062
+ * @public
915
1063
  */
916
1064
  export interface Participant {
917
1065
  /**
918
- * @public
919
1066
  * <p>Unique identifier for this participant, assigned by IVS.</p>
1067
+ * @public
920
1068
  */
921
1069
  participantId?: string;
922
1070
  /**
923
- * @public
924
1071
  * <p>Customer-assigned name to help identify the token; this can be used to link a
925
1072
  * participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
926
1073
  * <i>This field is exposed to all stage participants and should not be used for
927
1074
  * personally identifying, confidential, or sensitive information</i>.</p>
1075
+ * @public
928
1076
  */
929
1077
  userId?: string;
930
1078
  /**
931
- * @public
932
1079
  * <p>Whether the participant is connected to or disconnected from the stage.</p>
1080
+ * @public
933
1081
  */
934
1082
  state?: ParticipantState;
935
1083
  /**
936
- * @public
937
1084
  * <p>ISO 8601 timestamp (returned as a string) when the participant first joined the stage
938
1085
  * session.</p>
1086
+ * @public
939
1087
  */
940
1088
  firstJoinTime?: Date;
941
1089
  /**
942
- * @public
943
1090
  * <p>Application-provided attributes to encode into the token and attach to a stage. Map keys
944
1091
  * and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
945
1092
  * <i>This field is exposed to all stage participants and should not be used for
946
1093
  * personally identifying, confidential, or sensitive information</i>.</p>
1094
+ * @public
947
1095
  */
948
1096
  attributes?: Record<string, string>;
949
1097
  /**
950
- * @public
951
1098
  * <p>Whether the participant ever published to the stage session.</p>
1099
+ * @public
952
1100
  */
953
1101
  published?: boolean;
954
1102
  /**
955
- * @public
956
1103
  * <p>The participant’s Internet Service Provider.</p>
1104
+ * @public
957
1105
  */
958
1106
  ispName?: string;
959
1107
  /**
960
- * @public
961
1108
  * <p>The participant’s operating system.</p>
1109
+ * @public
962
1110
  */
963
1111
  osName?: string;
964
1112
  /**
965
- * @public
966
1113
  * <p>The participant’s operating system version.</p>
1114
+ * @public
967
1115
  */
968
1116
  osVersion?: string;
969
1117
  /**
970
- * @public
971
1118
  * <p>The participant’s browser.</p>
1119
+ * @public
972
1120
  */
973
1121
  browserName?: string;
974
1122
  /**
975
- * @public
976
1123
  * <p>The participant’s browser version.</p>
1124
+ * @public
977
1125
  */
978
1126
  browserVersion?: string;
979
1127
  /**
980
- * @public
981
1128
  * <p>The participant’s SDK version.</p>
1129
+ * @public
982
1130
  */
983
1131
  sdkVersion?: string;
984
1132
  }
@@ -987,8 +1135,8 @@ export interface Participant {
987
1135
  */
988
1136
  export interface GetParticipantResponse {
989
1137
  /**
990
- * @public
991
1138
  * <p>The participant that is returned.</p>
1139
+ * @public
992
1140
  */
993
1141
  participant?: Participant;
994
1142
  }
@@ -997,8 +1145,8 @@ export interface GetParticipantResponse {
997
1145
  */
998
1146
  export interface GetStageRequest {
999
1147
  /**
1000
- * @public
1001
1148
  * <p>ARN of the stage for which the information is to be retrieved.</p>
1149
+ * @public
1002
1150
  */
1003
1151
  arn: string | undefined;
1004
1152
  }
@@ -1007,8 +1155,8 @@ export interface GetStageRequest {
1007
1155
  */
1008
1156
  export interface GetStageResponse {
1009
1157
  /**
1010
- * @public
1011
1158
  * <p>The stage that is returned.</p>
1159
+ * @public
1012
1160
  */
1013
1161
  stage?: Stage;
1014
1162
  }
@@ -1017,38 +1165,38 @@ export interface GetStageResponse {
1017
1165
  */
1018
1166
  export interface GetStageSessionRequest {
1019
1167
  /**
1020
- * @public
1021
1168
  * <p>ARN of the stage for which the information is to be retrieved.</p>
1169
+ * @public
1022
1170
  */
1023
1171
  stageArn: string | undefined;
1024
1172
  /**
1025
- * @public
1026
1173
  * <p>ID of a session within the stage.</p>
1174
+ * @public
1027
1175
  */
1028
1176
  sessionId: string | undefined;
1029
1177
  }
1030
1178
  /**
1031
- * @public
1032
1179
  * <p>A stage session begins when the first participant joins a stage and ends after the last
1033
1180
  * participant leaves the stage. A stage session helps with debugging stages by grouping
1034
1181
  * events and participants into shorter periods of time (i.e., a session), which is helpful
1035
1182
  * when stages are used over long periods of time.</p>
1183
+ * @public
1036
1184
  */
1037
1185
  export interface StageSession {
1038
1186
  /**
1039
- * @public
1040
1187
  * <p>ID of the session within the stage.</p>
1188
+ * @public
1041
1189
  */
1042
1190
  sessionId?: string;
1043
1191
  /**
1044
- * @public
1045
1192
  * <p> ISO 8601 timestamp (returned as a string) when this stage session began.</p>
1193
+ * @public
1046
1194
  */
1047
1195
  startTime?: Date;
1048
1196
  /**
1049
- * @public
1050
1197
  * <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if
1051
1198
  * the stage is active.</p>
1199
+ * @public
1052
1200
  */
1053
1201
  endTime?: Date;
1054
1202
  }
@@ -1057,8 +1205,8 @@ export interface StageSession {
1057
1205
  */
1058
1206
  export interface GetStageSessionResponse {
1059
1207
  /**
1060
- * @public
1061
1208
  * <p>The stage session that is returned.</p>
1209
+ * @public
1062
1210
  */
1063
1211
  stageSession?: StageSession;
1064
1212
  }
@@ -1067,8 +1215,8 @@ export interface GetStageSessionResponse {
1067
1215
  */
1068
1216
  export interface GetStorageConfigurationRequest {
1069
1217
  /**
1070
- * @public
1071
1218
  * <p>ARN of the storage configuration to be retrieved.</p>
1219
+ * @public
1072
1220
  */
1073
1221
  arn: string | undefined;
1074
1222
  }
@@ -1077,8 +1225,8 @@ export interface GetStorageConfigurationRequest {
1077
1225
  */
1078
1226
  export interface GetStorageConfigurationResponse {
1079
1227
  /**
1080
- * @public
1081
1228
  * <p>The StorageConfiguration that was returned.</p>
1229
+ * @public
1082
1230
  */
1083
1231
  storageConfiguration?: StorageConfiguration;
1084
1232
  }
@@ -1087,100 +1235,100 @@ export interface GetStorageConfigurationResponse {
1087
1235
  */
1088
1236
  export interface ListCompositionsRequest {
1089
1237
  /**
1090
- * @public
1091
1238
  * <p>Filters the Composition list to match the specified Stage ARN.</p>
1239
+ * @public
1092
1240
  */
1093
1241
  filterByStageArn?: string;
1094
1242
  /**
1095
- * @public
1096
1243
  * <p>Filters the Composition list to match the specified EncoderConfiguration attached to at
1097
1244
  * least one of its output.</p>
1245
+ * @public
1098
1246
  */
1099
1247
  filterByEncoderConfigurationArn?: string;
1100
1248
  /**
1101
- * @public
1102
1249
  * <p>The first Composition to retrieve. This is used for pagination; see the
1103
1250
  * <code>nextToken</code> response field.</p>
1251
+ * @public
1104
1252
  */
1105
1253
  nextToken?: string;
1106
1254
  /**
1107
- * @public
1108
1255
  * <p>Maximum number of results to return. Default: 100.</p>
1256
+ * @public
1109
1257
  */
1110
1258
  maxResults?: number;
1111
1259
  }
1112
1260
  /**
1113
- * @public
1114
1261
  * <p>Summary information about a Destination.</p>
1262
+ * @public
1115
1263
  */
1116
1264
  export interface DestinationSummary {
1117
1265
  /**
1118
- * @public
1119
1266
  * <p>Unique identifier for this destination, assigned by IVS.</p>
1267
+ * @public
1120
1268
  */
1121
1269
  id: string | undefined;
1122
1270
  /**
1123
- * @public
1124
1271
  * <p>State of the Composition Destination.</p>
1272
+ * @public
1125
1273
  */
1126
1274
  state: DestinationState | undefined;
1127
1275
  /**
1128
- * @public
1129
1276
  * <p>UTC time of the destination start. This is an ISO 8601 timestamp; <i>note that
1130
1277
  * this is returned as a string</i>.</p>
1278
+ * @public
1131
1279
  */
1132
1280
  startTime?: Date;
1133
1281
  /**
1134
- * @public
1135
1282
  * <p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this
1136
1283
  * is returned as a string</i>.</p>
1284
+ * @public
1137
1285
  */
1138
1286
  endTime?: Date;
1139
1287
  }
1140
1288
  /**
1141
- * @public
1142
1289
  * <p>Summary information about a Composition.</p>
1290
+ * @public
1143
1291
  */
1144
1292
  export interface CompositionSummary {
1145
1293
  /**
1146
- * @public
1147
1294
  * <p>ARN of the Composition resource.</p>
1295
+ * @public
1148
1296
  */
1149
1297
  arn: string | undefined;
1150
1298
  /**
1151
- * @public
1152
1299
  * <p>ARN of the attached stage.</p>
1300
+ * @public
1153
1301
  */
1154
1302
  stageArn: string | undefined;
1155
1303
  /**
1156
- * @public
1157
1304
  * <p>Array of Destination objects.</p>
1305
+ * @public
1158
1306
  */
1159
1307
  destinations: DestinationSummary[] | undefined;
1160
1308
  /**
1161
- * @public
1162
1309
  * <p>State of the Composition resource.</p>
1310
+ * @public
1163
1311
  */
1164
1312
  state: CompositionState | undefined;
1165
1313
  /**
1166
- * @public
1167
1314
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1168
1315
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
1169
1316
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
1170
1317
  * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1171
1318
  * there.</p>
1319
+ * @public
1172
1320
  */
1173
1321
  tags?: Record<string, string>;
1174
1322
  /**
1175
- * @public
1176
1323
  * <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
1177
1324
  * this is returned as a string</i>.</p>
1325
+ * @public
1178
1326
  */
1179
1327
  startTime?: Date;
1180
1328
  /**
1181
- * @public
1182
1329
  * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that
1183
1330
  * this is returned as a string</i>.</p>
1331
+ * @public
1184
1332
  */
1185
1333
  endTime?: Date;
1186
1334
  }
@@ -1189,14 +1337,14 @@ export interface CompositionSummary {
1189
1337
  */
1190
1338
  export interface ListCompositionsResponse {
1191
1339
  /**
1192
- * @public
1193
1340
  * <p>List of the matching Compositions (summary information only).</p>
1341
+ * @public
1194
1342
  */
1195
1343
  compositions: CompositionSummary[] | undefined;
1196
1344
  /**
1197
- * @public
1198
1345
  * <p>If there are more compositions than <code>maxResults</code>, use <code>nextToken</code>
1199
1346
  * in the request to get the next set.</p>
1347
+ * @public
1200
1348
  */
1201
1349
  nextToken?: string;
1202
1350
  }
@@ -1205,39 +1353,39 @@ export interface ListCompositionsResponse {
1205
1353
  */
1206
1354
  export interface ListEncoderConfigurationsRequest {
1207
1355
  /**
1208
- * @public
1209
1356
  * <p>The first encoder configuration to retrieve. This is used for pagination; see the
1210
1357
  * <code>nextToken</code> response field.</p>
1358
+ * @public
1211
1359
  */
1212
1360
  nextToken?: string;
1213
1361
  /**
1214
- * @public
1215
1362
  * <p>Maximum number of results to return. Default: 100.</p>
1363
+ * @public
1216
1364
  */
1217
1365
  maxResults?: number;
1218
1366
  }
1219
1367
  /**
1220
- * @public
1221
1368
  * <p>Summary information about an EncoderConfiguration.</p>
1369
+ * @public
1222
1370
  */
1223
1371
  export interface EncoderConfigurationSummary {
1224
1372
  /**
1225
- * @public
1226
1373
  * <p>ARN of the EncoderConfiguration resource.</p>
1374
+ * @public
1227
1375
  */
1228
1376
  arn: string | undefined;
1229
1377
  /**
1230
- * @public
1231
1378
  * <p>Optional name to identify the resource.</p>
1379
+ * @public
1232
1380
  */
1233
1381
  name?: string;
1234
1382
  /**
1235
- * @public
1236
1383
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1237
1384
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
1238
1385
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
1239
1386
  * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1240
1387
  * there.</p>
1388
+ * @public
1241
1389
  */
1242
1390
  tags?: Record<string, string>;
1243
1391
  }
@@ -1246,14 +1394,14 @@ export interface EncoderConfigurationSummary {
1246
1394
  */
1247
1395
  export interface ListEncoderConfigurationsResponse {
1248
1396
  /**
1249
- * @public
1250
1397
  * <p>List of the matching EncoderConfigurations (summary information only).</p>
1398
+ * @public
1251
1399
  */
1252
1400
  encoderConfigurations: EncoderConfigurationSummary[] | undefined;
1253
1401
  /**
1254
- * @public
1255
1402
  * <p>If there are more encoder configurations than <code>maxResults</code>, use
1256
1403
  * <code>nextToken</code> in the request to get the next set.</p>
1404
+ * @public
1257
1405
  */
1258
1406
  nextToken?: string;
1259
1407
  }
@@ -1262,29 +1410,29 @@ export interface ListEncoderConfigurationsResponse {
1262
1410
  */
1263
1411
  export interface ListParticipantEventsRequest {
1264
1412
  /**
1265
- * @public
1266
1413
  * <p>Stage ARN.</p>
1414
+ * @public
1267
1415
  */
1268
1416
  stageArn: string | undefined;
1269
1417
  /**
1270
- * @public
1271
1418
  * <p>ID of a session within the stage.</p>
1419
+ * @public
1272
1420
  */
1273
1421
  sessionId: string | undefined;
1274
1422
  /**
1275
- * @public
1276
1423
  * <p>Unique identifier for this participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.</p>
1424
+ * @public
1277
1425
  */
1278
1426
  participantId: string | undefined;
1279
1427
  /**
1280
- * @public
1281
1428
  * <p>The first participant event to retrieve. This is used for pagination; see the
1282
1429
  * <code>nextToken</code> response field.</p>
1430
+ * @public
1283
1431
  */
1284
1432
  nextToken?: string;
1285
1433
  /**
1286
- * @public
1287
1434
  * <p>Maximum number of results to return. Default: 50.</p>
1435
+ * @public
1288
1436
  */
1289
1437
  maxResults?: number;
1290
1438
  }
@@ -1321,34 +1469,33 @@ export declare const EventName: {
1321
1469
  */
1322
1470
  export type EventName = (typeof EventName)[keyof typeof EventName];
1323
1471
  /**
1324
- * @public
1325
1472
  * <p>An occurrence during a stage session.</p>
1473
+ * @public
1326
1474
  */
1327
1475
  export interface Event {
1328
1476
  /**
1329
- * @public
1330
1477
  * <p>The name of the event.</p>
1478
+ * @public
1331
1479
  */
1332
1480
  name?: EventName;
1333
1481
  /**
1334
- * @public
1335
1482
  * <p>Unique identifier for the participant who triggered the event. This is assigned by
1336
1483
  * IVS.</p>
1484
+ * @public
1337
1485
  */
1338
1486
  participantId?: string;
1339
1487
  /**
1340
- * @public
1341
1488
  * <p>ISO 8601 timestamp (returned as a string) for when the event occurred.</p>
1489
+ * @public
1342
1490
  */
1343
1491
  eventTime?: Date;
1344
1492
  /**
1345
- * @public
1346
1493
  * <p>Unique identifier for the remote participant. For a subscribe event, this is the
1347
1494
  * publisher. For a publish or join event, this is null. This is assigned by IVS.</p>
1495
+ * @public
1348
1496
  */
1349
1497
  remoteParticipantId?: string;
1350
1498
  /**
1351
- * @public
1352
1499
  * <p>If the event is an error event, the error code is provided to give insight into the
1353
1500
  * specific error that occurred. If the event is not an error event, this field is null.
1354
1501
  * <code>INSUFFICIENT_CAPABILITIES</code> indicates that the participant tried to take an
@@ -1358,6 +1505,7 @@ export interface Event {
1358
1505
  * information, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">Service Quotas</a>.
1359
1506
  * <code>PUBLISHER_NOT_FOUND</code> indicates that the participant tried to subscribe to a
1360
1507
  * publisher that doesn’t exist. </p>
1508
+ * @public
1361
1509
  */
1362
1510
  errorCode?: EventErrorCode;
1363
1511
  }
@@ -1366,14 +1514,14 @@ export interface Event {
1366
1514
  */
1367
1515
  export interface ListParticipantEventsResponse {
1368
1516
  /**
1369
- * @public
1370
1517
  * <p>List of the matching events.</p>
1518
+ * @public
1371
1519
  */
1372
1520
  events: Event[] | undefined;
1373
1521
  /**
1374
- * @public
1375
1522
  * <p>If there are more events than <code>maxResults</code>, use <code>nextToken</code> in the
1376
1523
  * request to get the next set. </p>
1524
+ * @public
1377
1525
  */
1378
1526
  nextToken?: string;
1379
1527
  }
@@ -1382,82 +1530,82 @@ export interface ListParticipantEventsResponse {
1382
1530
  */
1383
1531
  export interface ListParticipantsRequest {
1384
1532
  /**
1385
- * @public
1386
1533
  * <p>Stage ARN.</p>
1534
+ * @public
1387
1535
  */
1388
1536
  stageArn: string | undefined;
1389
1537
  /**
1390
- * @public
1391
1538
  * <p>ID of the session within the stage.</p>
1539
+ * @public
1392
1540
  */
1393
1541
  sessionId: string | undefined;
1394
1542
  /**
1395
- * @public
1396
1543
  * <p>Filters the response list to match the specified user ID. Only one of
1397
1544
  * <code>filterByUserId</code>, <code>filterByPublished</code>, or
1398
1545
  * <code>filterByState</code> can be provided per request. A <code>userId</code> is a
1399
1546
  * customer-assigned name to help identify the token; this can be used to link a participant
1400
1547
  * to a user in the customer’s own systems.</p>
1548
+ * @public
1401
1549
  */
1402
1550
  filterByUserId?: string;
1403
1551
  /**
1404
- * @public
1405
1552
  * <p>Filters the response list to only show participants who published during the stage
1406
1553
  * session. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or
1407
1554
  * <code>filterByState</code> can be provided per request.</p>
1555
+ * @public
1408
1556
  */
1409
1557
  filterByPublished?: boolean;
1410
1558
  /**
1411
- * @public
1412
1559
  * <p>Filters the response list to only show participants in the specified state. Only one of
1413
1560
  * <code>filterByUserId</code>, <code>filterByPublished</code>, or
1414
1561
  * <code>filterByState</code> can be provided per request.</p>
1562
+ * @public
1415
1563
  */
1416
1564
  filterByState?: ParticipantState;
1417
1565
  /**
1418
- * @public
1419
1566
  * <p>The first participant to retrieve. This is used for pagination; see the
1420
1567
  * <code>nextToken</code> response field.</p>
1568
+ * @public
1421
1569
  */
1422
1570
  nextToken?: string;
1423
1571
  /**
1424
- * @public
1425
1572
  * <p>Maximum number of results to return. Default: 50.</p>
1573
+ * @public
1426
1574
  */
1427
1575
  maxResults?: number;
1428
1576
  }
1429
1577
  /**
1430
- * @public
1431
1578
  * <p>Summary object describing a participant that has joined a stage.</p>
1579
+ * @public
1432
1580
  */
1433
1581
  export interface ParticipantSummary {
1434
1582
  /**
1435
- * @public
1436
1583
  * <p>Unique identifier for this participant, assigned by IVS.</p>
1584
+ * @public
1437
1585
  */
1438
1586
  participantId?: string;
1439
1587
  /**
1440
- * @public
1441
1588
  * <p>Customer-assigned name to help identify the token; this can be used to link a
1442
1589
  * participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
1443
1590
  * <i>This field is exposed to all stage participants and should not be used for
1444
1591
  * personally identifying, confidential, or sensitive information</i>.</p>
1592
+ * @public
1445
1593
  */
1446
1594
  userId?: string;
1447
1595
  /**
1448
- * @public
1449
1596
  * <p>Whether the participant is connected to or disconnected from the stage.</p>
1597
+ * @public
1450
1598
  */
1451
1599
  state?: ParticipantState;
1452
1600
  /**
1453
- * @public
1454
1601
  * <p>ISO 8601 timestamp (returned as a string) when the participant first joined the stage
1455
1602
  * session.</p>
1603
+ * @public
1456
1604
  */
1457
1605
  firstJoinTime?: Date;
1458
1606
  /**
1459
- * @public
1460
1607
  * <p>Whether the participant ever published to the stage session.</p>
1608
+ * @public
1461
1609
  */
1462
1610
  published?: boolean;
1463
1611
  }
@@ -1466,14 +1614,14 @@ export interface ParticipantSummary {
1466
1614
  */
1467
1615
  export interface ListParticipantsResponse {
1468
1616
  /**
1469
- * @public
1470
1617
  * <p>List of the matching participants (summary information only).</p>
1618
+ * @public
1471
1619
  */
1472
1620
  participants: ParticipantSummary[] | undefined;
1473
1621
  /**
1474
- * @public
1475
1622
  * <p>If there are more participants than <code>maxResults</code>, use <code>nextToken</code>
1476
1623
  * in the request to get the next set.</p>
1624
+ * @public
1477
1625
  */
1478
1626
  nextToken?: string;
1479
1627
  }
@@ -1482,44 +1630,44 @@ export interface ListParticipantsResponse {
1482
1630
  */
1483
1631
  export interface ListStagesRequest {
1484
1632
  /**
1485
- * @public
1486
1633
  * <p>The first stage to retrieve. This is used for pagination; see the <code>nextToken</code>
1487
1634
  * response field.</p>
1635
+ * @public
1488
1636
  */
1489
1637
  nextToken?: string;
1490
1638
  /**
1491
- * @public
1492
1639
  * <p>Maximum number of results to return. Default: 50.</p>
1640
+ * @public
1493
1641
  */
1494
1642
  maxResults?: number;
1495
1643
  }
1496
1644
  /**
1497
- * @public
1498
1645
  * <p>Summary information about a stage.</p>
1646
+ * @public
1499
1647
  */
1500
1648
  export interface StageSummary {
1501
1649
  /**
1502
- * @public
1503
1650
  * <p>Stage ARN.</p>
1651
+ * @public
1504
1652
  */
1505
1653
  arn: string | undefined;
1506
1654
  /**
1507
- * @public
1508
1655
  * <p>Stage name.</p>
1656
+ * @public
1509
1657
  */
1510
1658
  name?: string;
1511
1659
  /**
1512
- * @public
1513
1660
  * <p>ID of the active session within the stage.</p>
1661
+ * @public
1514
1662
  */
1515
1663
  activeSessionId?: string;
1516
1664
  /**
1517
- * @public
1518
1665
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1519
1666
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
1520
1667
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
1521
1668
  * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1522
1669
  * there.</p>
1670
+ * @public
1523
1671
  */
1524
1672
  tags?: Record<string, string>;
1525
1673
  }
@@ -1528,14 +1676,14 @@ export interface StageSummary {
1528
1676
  */
1529
1677
  export interface ListStagesResponse {
1530
1678
  /**
1531
- * @public
1532
1679
  * <p>List of the matching stages (summary information only).</p>
1680
+ * @public
1533
1681
  */
1534
1682
  stages: StageSummary[] | undefined;
1535
1683
  /**
1536
- * @public
1537
1684
  * <p>If there are more stages than <code>maxResults</code>, use <code>nextToken</code> in the
1538
1685
  * request to get the next set.</p>
1686
+ * @public
1539
1687
  */
1540
1688
  nextToken?: string;
1541
1689
  }
@@ -1544,41 +1692,41 @@ export interface ListStagesResponse {
1544
1692
  */
1545
1693
  export interface ListStageSessionsRequest {
1546
1694
  /**
1547
- * @public
1548
1695
  * <p>Stage ARN.</p>
1696
+ * @public
1549
1697
  */
1550
1698
  stageArn: string | undefined;
1551
1699
  /**
1552
- * @public
1553
1700
  * <p>The first stage session to retrieve. This is used for pagination; see the
1554
1701
  * <code>nextToken</code> response field.</p>
1702
+ * @public
1555
1703
  */
1556
1704
  nextToken?: string;
1557
1705
  /**
1558
- * @public
1559
1706
  * <p>Maximum number of results to return. Default: 50.</p>
1707
+ * @public
1560
1708
  */
1561
1709
  maxResults?: number;
1562
1710
  }
1563
1711
  /**
1564
- * @public
1565
1712
  * <p>Summary information about a stage session.</p>
1713
+ * @public
1566
1714
  */
1567
1715
  export interface StageSessionSummary {
1568
1716
  /**
1569
- * @public
1570
1717
  * <p>ID of the session within the stage.</p>
1718
+ * @public
1571
1719
  */
1572
1720
  sessionId?: string;
1573
1721
  /**
1574
- * @public
1575
1722
  * <p> ISO 8601 timestamp (returned as a string) when this stage session began.</p>
1723
+ * @public
1576
1724
  */
1577
1725
  startTime?: Date;
1578
1726
  /**
1579
- * @public
1580
1727
  * <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if
1581
1728
  * the stage is active.</p>
1729
+ * @public
1582
1730
  */
1583
1731
  endTime?: Date;
1584
1732
  }
@@ -1587,14 +1735,14 @@ export interface StageSessionSummary {
1587
1735
  */
1588
1736
  export interface ListStageSessionsResponse {
1589
1737
  /**
1590
- * @public
1591
1738
  * <p>List of matching stage sessions.</p>
1739
+ * @public
1592
1740
  */
1593
1741
  stageSessions: StageSessionSummary[] | undefined;
1594
1742
  /**
1595
- * @public
1596
1743
  * <p>If there are more stage sessions than <code>maxResults</code>, use
1597
1744
  * <code>nextToken</code> in the request to get the next set.</p>
1745
+ * @public
1598
1746
  */
1599
1747
  nextToken?: string;
1600
1748
  }
@@ -1603,45 +1751,45 @@ export interface ListStageSessionsResponse {
1603
1751
  */
1604
1752
  export interface ListStorageConfigurationsRequest {
1605
1753
  /**
1606
- * @public
1607
1754
  * <p>The first storage configuration to retrieve. This is used for pagination;
1608
1755
  * see the <code>nextToken</code> response field.</p>
1756
+ * @public
1609
1757
  */
1610
1758
  nextToken?: string;
1611
1759
  /**
1612
- * @public
1613
1760
  * <p>Maximum number of storage configurations to return. Default: your service quota or 100,
1614
1761
  * whichever is smaller.</p>
1762
+ * @public
1615
1763
  */
1616
1764
  maxResults?: number;
1617
1765
  }
1618
1766
  /**
1619
- * @public
1620
1767
  * <p>Summary information about a storage configuration.</p>
1768
+ * @public
1621
1769
  */
1622
1770
  export interface StorageConfigurationSummary {
1623
1771
  /**
1624
- * @public
1625
1772
  * <p>ARN of the storage configuration.</p>
1773
+ * @public
1626
1774
  */
1627
1775
  arn: string | undefined;
1628
1776
  /**
1629
- * @public
1630
1777
  * <p>Name of the storage configuration.</p>
1778
+ * @public
1631
1779
  */
1632
1780
  name?: string;
1633
1781
  /**
1634
- * @public
1635
1782
  * <p>An S3 destination configuration where recorded videos will be stored.</p>
1783
+ * @public
1636
1784
  */
1637
1785
  s3?: S3StorageConfiguration;
1638
1786
  /**
1639
- * @public
1640
1787
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1641
1788
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
1642
1789
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
1643
1790
  * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1644
1791
  * there.</p>
1792
+ * @public
1645
1793
  */
1646
1794
  tags?: Record<string, string>;
1647
1795
  }
@@ -1650,14 +1798,14 @@ export interface StorageConfigurationSummary {
1650
1798
  */
1651
1799
  export interface ListStorageConfigurationsResponse {
1652
1800
  /**
1653
- * @public
1654
1801
  * <p>List of the matching storage configurations.</p>
1802
+ * @public
1655
1803
  */
1656
1804
  storageConfigurations: StorageConfigurationSummary[] | undefined;
1657
1805
  /**
1658
- * @public
1659
1806
  * <p>If there are more storage configurations than <code>maxResults</code>, use <code>nextToken</code>
1660
1807
  * in the request to get the next set.</p>
1808
+ * @public
1661
1809
  */
1662
1810
  nextToken?: string;
1663
1811
  }
@@ -1666,8 +1814,8 @@ export interface ListStorageConfigurationsResponse {
1666
1814
  */
1667
1815
  export interface ListTagsForResourceRequest {
1668
1816
  /**
1669
- * @public
1670
1817
  * <p>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</p>
1818
+ * @public
1671
1819
  */
1672
1820
  resourceArn: string | undefined;
1673
1821
  }
@@ -1676,9 +1824,9 @@ export interface ListTagsForResourceRequest {
1676
1824
  */
1677
1825
  export interface ListTagsForResourceResponse {
1678
1826
  /**
1679
- * @public
1680
1827
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1681
1828
  * (key:value)</code>.</p>
1829
+ * @public
1682
1830
  */
1683
1831
  tags: Record<string, string> | undefined;
1684
1832
  }
@@ -1687,32 +1835,32 @@ export interface ListTagsForResourceResponse {
1687
1835
  */
1688
1836
  export interface StartCompositionRequest {
1689
1837
  /**
1690
- * @public
1691
1838
  * <p>ARN of the stage to be used for compositing.</p>
1839
+ * @public
1692
1840
  */
1693
1841
  stageArn: string | undefined;
1694
1842
  /**
1695
- * @public
1696
1843
  * <p>Idempotency token.</p>
1844
+ * @public
1697
1845
  */
1698
1846
  idempotencyToken?: string;
1699
1847
  /**
1700
- * @public
1701
1848
  * <p>Layout object to configure composition parameters.</p>
1849
+ * @public
1702
1850
  */
1703
1851
  layout?: LayoutConfiguration;
1704
1852
  /**
1705
- * @public
1706
1853
  * <p>Array of destination configuration.</p>
1854
+ * @public
1707
1855
  */
1708
1856
  destinations: DestinationConfiguration[] | undefined;
1709
1857
  /**
1710
- * @public
1711
1858
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1712
1859
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
1713
1860
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
1714
1861
  * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1715
1862
  * there.</p>
1863
+ * @public
1716
1864
  */
1717
1865
  tags?: Record<string, string>;
1718
1866
  }
@@ -1721,8 +1869,8 @@ export interface StartCompositionRequest {
1721
1869
  */
1722
1870
  export interface StartCompositionResponse {
1723
1871
  /**
1724
- * @public
1725
1872
  * <p>The Composition that was created.</p>
1873
+ * @public
1726
1874
  */
1727
1875
  composition?: Composition;
1728
1876
  }
@@ -1731,8 +1879,8 @@ export interface StartCompositionResponse {
1731
1879
  */
1732
1880
  export interface StopCompositionRequest {
1733
1881
  /**
1734
- * @public
1735
1882
  * <p>ARN of the Composition.</p>
1883
+ * @public
1736
1884
  */
1737
1885
  arn: string | undefined;
1738
1886
  }
@@ -1746,17 +1894,17 @@ export interface StopCompositionResponse {
1746
1894
  */
1747
1895
  export interface TagResourceRequest {
1748
1896
  /**
1749
- * @public
1750
1897
  * <p>The ARN of the resource to be tagged. The ARN must be URL-encoded.</p>
1898
+ * @public
1751
1899
  */
1752
1900
  resourceArn: string | undefined;
1753
1901
  /**
1754
- * @public
1755
1902
  * <p>Array of tags to be added or updated. Array of maps, each of the form
1756
1903
  * <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
1757
1904
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
1758
1905
  * limits and requirements"; Amazon IVS has no constraints beyond what is documented
1759
1906
  * there.</p>
1907
+ * @public
1760
1908
  */
1761
1909
  tags: Record<string, string> | undefined;
1762
1910
  }
@@ -1770,17 +1918,17 @@ export interface TagResourceResponse {
1770
1918
  */
1771
1919
  export interface UntagResourceRequest {
1772
1920
  /**
1773
- * @public
1774
1921
  * <p>The ARN of the resource to be untagged. The ARN must be URL-encoded.</p>
1922
+ * @public
1775
1923
  */
1776
1924
  resourceArn: string | undefined;
1777
1925
  /**
1778
- * @public
1779
1926
  * <p>Array of tags to be removed. Array of maps, each of the form <code>string:string
1780
1927
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
1781
1928
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
1782
1929
  * limits and requirements"; Amazon IVS has no constraints beyond what is documented
1783
1930
  * there.</p>
1931
+ * @public
1784
1932
  */
1785
1933
  tagKeys: string[] | undefined;
1786
1934
  }
@@ -1794,13 +1942,13 @@ export interface UntagResourceResponse {
1794
1942
  */
1795
1943
  export interface UpdateStageRequest {
1796
1944
  /**
1797
- * @public
1798
1945
  * <p>ARN of the stage to be updated.</p>
1946
+ * @public
1799
1947
  */
1800
1948
  arn: string | undefined;
1801
1949
  /**
1802
- * @public
1803
1950
  * <p>Name of the stage to be updated.</p>
1951
+ * @public
1804
1952
  */
1805
1953
  name?: string;
1806
1954
  }
@@ -1809,8 +1957,8 @@ export interface UpdateStageRequest {
1809
1957
  */
1810
1958
  export interface UpdateStageResponse {
1811
1959
  /**
1812
- * @public
1813
1960
  * <p>The updated stage.</p>
1961
+ * @public
1814
1962
  */
1815
1963
  stage?: Stage;
1816
1964
  }