@aws-sdk/client-ivs-realtime 3.451.0 → 3.453.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 (85) hide show
  1. package/README.md +184 -5
  2. package/dist-cjs/IVSRealTime.js +24 -0
  3. package/dist-cjs/commands/CreateEncoderConfigurationCommand.js +51 -0
  4. package/dist-cjs/commands/CreateStorageConfigurationCommand.js +51 -0
  5. package/dist-cjs/commands/DeleteEncoderConfigurationCommand.js +51 -0
  6. package/dist-cjs/commands/DeleteStorageConfigurationCommand.js +51 -0
  7. package/dist-cjs/commands/GetCompositionCommand.js +51 -0
  8. package/dist-cjs/commands/GetEncoderConfigurationCommand.js +51 -0
  9. package/dist-cjs/commands/GetStorageConfigurationCommand.js +51 -0
  10. package/dist-cjs/commands/ListCompositionsCommand.js +51 -0
  11. package/dist-cjs/commands/ListEncoderConfigurationsCommand.js +51 -0
  12. package/dist-cjs/commands/ListStorageConfigurationsCommand.js +51 -0
  13. package/dist-cjs/commands/StartCompositionCommand.js +51 -0
  14. package/dist-cjs/commands/StopCompositionCommand.js +51 -0
  15. package/dist-cjs/commands/index.js +12 -0
  16. package/dist-cjs/models/models_0.js +51 -33
  17. package/dist-cjs/pagination/ListCompositionsPaginator.js +29 -0
  18. package/dist-cjs/pagination/ListEncoderConfigurationsPaginator.js +29 -0
  19. package/dist-cjs/pagination/ListStorageConfigurationsPaginator.js +29 -0
  20. package/dist-cjs/pagination/index.js +3 -0
  21. package/dist-cjs/protocols/Aws_restJson1.js +1036 -101
  22. package/dist-es/IVSRealTime.js +24 -0
  23. package/dist-es/commands/CreateEncoderConfigurationCommand.js +47 -0
  24. package/dist-es/commands/CreateStorageConfigurationCommand.js +47 -0
  25. package/dist-es/commands/DeleteEncoderConfigurationCommand.js +47 -0
  26. package/dist-es/commands/DeleteStorageConfigurationCommand.js +47 -0
  27. package/dist-es/commands/GetCompositionCommand.js +47 -0
  28. package/dist-es/commands/GetEncoderConfigurationCommand.js +47 -0
  29. package/dist-es/commands/GetStorageConfigurationCommand.js +47 -0
  30. package/dist-es/commands/ListCompositionsCommand.js +47 -0
  31. package/dist-es/commands/ListEncoderConfigurationsCommand.js +47 -0
  32. package/dist-es/commands/ListStorageConfigurationsCommand.js +47 -0
  33. package/dist-es/commands/StartCompositionCommand.js +47 -0
  34. package/dist-es/commands/StopCompositionCommand.js +47 -0
  35. package/dist-es/commands/index.js +12 -0
  36. package/dist-es/models/models_0.js +48 -30
  37. package/dist-es/pagination/ListCompositionsPaginator.js +25 -0
  38. package/dist-es/pagination/ListEncoderConfigurationsPaginator.js +25 -0
  39. package/dist-es/pagination/ListStorageConfigurationsPaginator.js +25 -0
  40. package/dist-es/pagination/index.js +3 -0
  41. package/dist-es/protocols/Aws_restJson1.js +1002 -92
  42. package/dist-types/IVSRealTime.d.ts +172 -5
  43. package/dist-types/IVSRealTimeClient.d.ts +102 -7
  44. package/dist-types/commands/CreateEncoderConfigurationCommand.d.ts +115 -0
  45. package/dist-types/commands/CreateStorageConfigurationCommand.d.ts +111 -0
  46. package/dist-types/commands/DeleteEncoderConfigurationCommand.d.ts +90 -0
  47. package/dist-types/commands/DeleteStorageConfigurationCommand.d.ts +92 -0
  48. package/dist-types/commands/GetCompositionCommand.d.ts +134 -0
  49. package/dist-types/commands/GetEncoderConfigurationCommand.d.ts +103 -0
  50. package/dist-types/commands/GetStorageConfigurationCommand.d.ts +100 -0
  51. package/dist-types/commands/ListCompositionsCommand.d.ts +112 -0
  52. package/dist-types/commands/ListEncoderConfigurationsCommand.d.ts +99 -0
  53. package/dist-types/commands/ListStorageConfigurationsCommand.d.ts +102 -0
  54. package/dist-types/commands/StartCompositionCommand.d.ts +187 -0
  55. package/dist-types/commands/StopCompositionCommand.d.ts +90 -0
  56. package/dist-types/commands/index.d.ts +12 -0
  57. package/dist-types/index.d.ts +88 -5
  58. package/dist-types/models/models_0.d.ts +908 -92
  59. package/dist-types/pagination/ListCompositionsPaginator.d.ts +7 -0
  60. package/dist-types/pagination/ListEncoderConfigurationsPaginator.d.ts +7 -0
  61. package/dist-types/pagination/ListStorageConfigurationsPaginator.d.ts +7 -0
  62. package/dist-types/pagination/index.d.ts +3 -0
  63. package/dist-types/protocols/Aws_restJson1.d.ts +108 -0
  64. package/dist-types/ts3.4/IVSRealTime.d.ts +204 -0
  65. package/dist-types/ts3.4/IVSRealTimeClient.d.ts +72 -0
  66. package/dist-types/ts3.4/commands/CreateEncoderConfigurationCommand.d.ts +42 -0
  67. package/dist-types/ts3.4/commands/CreateStorageConfigurationCommand.d.ts +42 -0
  68. package/dist-types/ts3.4/commands/DeleteEncoderConfigurationCommand.d.ts +42 -0
  69. package/dist-types/ts3.4/commands/DeleteStorageConfigurationCommand.d.ts +42 -0
  70. package/dist-types/ts3.4/commands/GetCompositionCommand.d.ts +38 -0
  71. package/dist-types/ts3.4/commands/GetEncoderConfigurationCommand.d.ts +42 -0
  72. package/dist-types/ts3.4/commands/GetStorageConfigurationCommand.d.ts +42 -0
  73. package/dist-types/ts3.4/commands/ListCompositionsCommand.d.ts +38 -0
  74. package/dist-types/ts3.4/commands/ListEncoderConfigurationsCommand.d.ts +42 -0
  75. package/dist-types/ts3.4/commands/ListStorageConfigurationsCommand.d.ts +42 -0
  76. package/dist-types/ts3.4/commands/StartCompositionCommand.d.ts +38 -0
  77. package/dist-types/ts3.4/commands/StopCompositionCommand.d.ts +38 -0
  78. package/dist-types/ts3.4/commands/index.d.ts +12 -0
  79. package/dist-types/ts3.4/models/models_0.d.ts +234 -34
  80. package/dist-types/ts3.4/pagination/ListCompositionsPaginator.d.ts +11 -0
  81. package/dist-types/ts3.4/pagination/ListEncoderConfigurationsPaginator.d.ts +11 -0
  82. package/dist-types/ts3.4/pagination/ListStorageConfigurationsPaginator.d.ts +11 -0
  83. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  84. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +144 -0
  85. package/package.json +4 -2
@@ -19,115 +19,133 @@ export declare class AccessDeniedException extends __BaseException {
19
19
  }
20
20
  /**
21
21
  * @public
22
- * @enum
23
- */
24
- export declare const ParticipantTokenCapability: {
25
- readonly PUBLISH: "PUBLISH";
26
- readonly SUBSCRIBE: "SUBSCRIBE";
27
- };
28
- /**
29
- * @public
22
+ * <p/>
30
23
  */
31
- export type ParticipantTokenCapability = (typeof ParticipantTokenCapability)[keyof typeof ParticipantTokenCapability];
24
+ export declare class ConflictException extends __BaseException {
25
+ readonly name: "ConflictException";
26
+ readonly $fault: "client";
27
+ /**
28
+ * @public
29
+ * <p>Updating or deleting a resource can cause an inconsistent state.</p>
30
+ */
31
+ exceptionMessage?: string;
32
+ /**
33
+ * @internal
34
+ */
35
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
36
+ }
32
37
  /**
33
38
  * @public
39
+ * <p>Settings for video.</p>
34
40
  */
35
- export interface CreateParticipantTokenRequest {
41
+ export interface Video {
36
42
  /**
37
43
  * @public
38
- * <p>ARN of the stage to which this token is scoped.</p>
44
+ * <p>Video-resolution width. Note that the maximum value is determined by <code>width</code>
45
+ * times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or
46
+ * 1080x1920). Default: 1280.</p>
39
47
  */
40
- stageArn: string | undefined;
48
+ width?: number;
41
49
  /**
42
50
  * @public
43
- * <p>Duration (in minutes), after which the token expires. Default: 720 (12 hours).</p>
51
+ * <p>Video-resolution height. Note that the maximum value is determined by <code>width</code>
52
+ * times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or
53
+ * 1080x1920). Default: 720.</p>
44
54
  */
45
- duration?: number;
55
+ height?: number;
46
56
  /**
47
57
  * @public
48
- * <p>Name that can be specified to help identify the token. This can be any UTF-8 encoded
49
- * text. <i>This field is exposed to all stage participants and should not be used for
50
- * personally identifying, confidential, or sensitive information.</i>
51
- * </p>
58
+ * <p>Video frame rate, in fps. Default: 30.</p>
52
59
  */
53
- userId?: string;
60
+ framerate?: number;
54
61
  /**
55
62
  * @public
56
- * <p>Application-provided attributes to encode into the token and attach to a stage. Map keys
57
- * and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
58
- * <i>This field is exposed to all stage participants and should not be used for
59
- * personally identifying, confidential, or sensitive information.</i>
60
- * </p>
63
+ * <p>Bitrate for generated output, in bps. Default: 2500000.</p>
61
64
  */
62
- attributes?: Record<string, string>;
63
- /**
64
- * @public
65
- * <p>Set of capabilities that the user is allowed to perform in the stage. Default:
66
- * <code>PUBLISH, SUBSCRIBE</code>.</p>
67
- */
68
- capabilities?: ParticipantTokenCapability[];
65
+ bitrate?: number;
69
66
  }
70
67
  /**
71
68
  * @public
72
- * <p>Object specifying a participant token in a stage.</p>
73
- * <p>
74
- * <b>Important</b>: Treat tokens as opaque; i.e., do not build functionality
75
- * based on token contents. The format of tokens could change in the future.</p>
76
69
  */
77
- export interface ParticipantToken {
70
+ export interface CreateEncoderConfigurationRequest {
78
71
  /**
79
72
  * @public
80
- * <p>Unique identifier for this participant token, assigned by IVS.</p>
73
+ * <p>Optional name to identify the resource.</p>
81
74
  */
82
- participantId?: string;
75
+ name?: string;
83
76
  /**
84
77
  * @public
85
- * <p>The issued client token, encrypted.</p>
78
+ * <p>Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30
79
+ * fps.</p>
86
80
  */
87
- token?: string;
81
+ video?: Video;
88
82
  /**
89
83
  * @public
90
- * <p>Customer-assigned name to help identify the token; this can be used to link a
91
- * participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
92
- * <i>This field is exposed to all stage participants and should not be used for
93
- * personally identifying, confidential, or sensitive information.</i>
94
- * </p>
84
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
85
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
86
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
87
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
88
+ * there.</p>
95
89
  */
96
- userId?: string;
90
+ tags?: Record<string, string>;
91
+ }
92
+ /**
93
+ * @public
94
+ * <p>Settings for transcoding.</p>
95
+ */
96
+ export interface EncoderConfiguration {
97
97
  /**
98
98
  * @public
99
- * <p>Application-provided attributes to encode into the token and attach to a stage.
100
- * <i>This field is exposed to all stage participants and should not be used for
101
- * personally identifying, confidential, or sensitive information.</i>
102
- * </p>
99
+ * <p>ARN of the EncoderConfiguration resource.</p>
103
100
  */
104
- attributes?: Record<string, string>;
101
+ arn: string | undefined;
105
102
  /**
106
103
  * @public
107
- * <p>Duration (in minutes), after which the participant token expires. Default: 720 (12
108
- * hours).</p>
104
+ * <p>Optional name to identify the resource.</p>
109
105
  */
110
- duration?: number;
106
+ name?: string;
111
107
  /**
112
108
  * @public
113
- * <p>Set of capabilities that the user is allowed to perform in the stage.</p>
109
+ * <p>Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30
110
+ * fps</p>
114
111
  */
115
- capabilities?: ParticipantTokenCapability[];
112
+ video?: Video;
116
113
  /**
117
114
  * @public
118
- * <p>ISO 8601 timestamp (returned as a string) for when this token expires.</p>
115
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
116
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
117
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
118
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
119
+ * there.</p>
119
120
  */
120
- expirationTime?: Date;
121
+ tags?: Record<string, string>;
121
122
  }
122
123
  /**
123
124
  * @public
124
125
  */
125
- export interface CreateParticipantTokenResponse {
126
+ export interface CreateEncoderConfigurationResponse {
126
127
  /**
127
128
  * @public
128
- * <p>The participant token that was created.</p>
129
+ * <p>The EncoderConfiguration that was created.</p>
129
130
  */
130
- participantToken?: ParticipantToken;
131
+ encoderConfiguration?: EncoderConfiguration;
132
+ }
133
+ /**
134
+ * @public
135
+ * <p/>
136
+ */
137
+ export declare class InternalServerException extends __BaseException {
138
+ readonly name: "InternalServerException";
139
+ readonly $fault: "server";
140
+ /**
141
+ * @public
142
+ * <p>Unexpected error during processing of request.</p>
143
+ */
144
+ exceptionMessage?: string;
145
+ /**
146
+ * @internal
147
+ */
148
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
131
149
  }
132
150
  /**
133
151
  * @public
@@ -197,6 +215,118 @@ export declare class ValidationException extends __BaseException {
197
215
  */
198
216
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
199
217
  }
218
+ /**
219
+ * @public
220
+ * @enum
221
+ */
222
+ export declare const ParticipantTokenCapability: {
223
+ readonly PUBLISH: "PUBLISH";
224
+ readonly SUBSCRIBE: "SUBSCRIBE";
225
+ };
226
+ /**
227
+ * @public
228
+ */
229
+ export type ParticipantTokenCapability = (typeof ParticipantTokenCapability)[keyof typeof ParticipantTokenCapability];
230
+ /**
231
+ * @public
232
+ */
233
+ export interface CreateParticipantTokenRequest {
234
+ /**
235
+ * @public
236
+ * <p>ARN of the stage to which this token is scoped.</p>
237
+ */
238
+ stageArn: string | undefined;
239
+ /**
240
+ * @public
241
+ * <p>Duration (in minutes), after which the token expires. Default: 720 (12 hours).</p>
242
+ */
243
+ duration?: number;
244
+ /**
245
+ * @public
246
+ * <p>Name that can be specified to help identify the token. This can be any UTF-8 encoded
247
+ * text. <i>This field is exposed to all stage participants and should not be used for
248
+ * personally identifying, confidential, or sensitive information.</i>
249
+ * </p>
250
+ */
251
+ userId?: string;
252
+ /**
253
+ * @public
254
+ * <p>Application-provided attributes to encode into the token and attach to a stage. Map keys
255
+ * and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
256
+ * <i>This field is exposed to all stage participants and should not be used for
257
+ * personally identifying, confidential, or sensitive information.</i>
258
+ * </p>
259
+ */
260
+ attributes?: Record<string, string>;
261
+ /**
262
+ * @public
263
+ * <p>Set of capabilities that the user is allowed to perform in the stage. Default:
264
+ * <code>PUBLISH, SUBSCRIBE</code>.</p>
265
+ */
266
+ capabilities?: ParticipantTokenCapability[];
267
+ }
268
+ /**
269
+ * @public
270
+ * <p>Object specifying a participant token in a stage.</p>
271
+ * <p>
272
+ * <b>Important</b>: Treat tokens as opaque; i.e., do not build functionality
273
+ * based on token contents. The format of tokens could change in the future.</p>
274
+ */
275
+ export interface ParticipantToken {
276
+ /**
277
+ * @public
278
+ * <p>Unique identifier for this participant token, assigned by IVS.</p>
279
+ */
280
+ participantId?: string;
281
+ /**
282
+ * @public
283
+ * <p>The issued client token, encrypted.</p>
284
+ */
285
+ token?: string;
286
+ /**
287
+ * @public
288
+ * <p>Customer-assigned name to help identify the token; this can be used to link a
289
+ * participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
290
+ * <i>This field is exposed to all stage participants and should not be used for
291
+ * personally identifying, confidential, or sensitive information.</i>
292
+ * </p>
293
+ */
294
+ userId?: string;
295
+ /**
296
+ * @public
297
+ * <p>Application-provided attributes to encode into the token and attach to a stage.
298
+ * <i>This field is exposed to all stage participants and should not be used for
299
+ * personally identifying, confidential, or sensitive information.</i>
300
+ * </p>
301
+ */
302
+ attributes?: Record<string, string>;
303
+ /**
304
+ * @public
305
+ * <p>Duration (in minutes), after which the participant token expires. Default: 720 (12
306
+ * hours).</p>
307
+ */
308
+ duration?: number;
309
+ /**
310
+ * @public
311
+ * <p>Set of capabilities that the user is allowed to perform in the stage.</p>
312
+ */
313
+ capabilities?: ParticipantTokenCapability[];
314
+ /**
315
+ * @public
316
+ * <p>ISO 8601 timestamp (returned as a string) for when this token expires.</p>
317
+ */
318
+ expirationTime?: Date;
319
+ }
320
+ /**
321
+ * @public
322
+ */
323
+ export interface CreateParticipantTokenResponse {
324
+ /**
325
+ * @public
326
+ * <p>The participant token that was created.</p>
327
+ */
328
+ participantToken?: ParticipantToken;
329
+ }
200
330
  /**
201
331
  * @public
202
332
  * <p>Object specifying a participant token configuration in a stage.</p>
@@ -305,20 +435,94 @@ export interface CreateStageResponse {
305
435
  }
306
436
  /**
307
437
  * @public
308
- * <p/>
438
+ * <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
309
439
  */
310
- export declare class ConflictException extends __BaseException {
311
- readonly name: "ConflictException";
312
- readonly $fault: "client";
440
+ export interface S3StorageConfiguration {
313
441
  /**
314
442
  * @public
315
- * <p>Updating or deleting a resource can cause an inconsistent state.</p>
443
+ * <p>Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration
444
+ * and S3 bucket must be in the same region as the Composition.</p>
316
445
  */
317
- exceptionMessage?: string;
446
+ bucketName: string | undefined;
447
+ }
448
+ /**
449
+ * @public
450
+ */
451
+ export interface CreateStorageConfigurationRequest {
318
452
  /**
319
- * @internal
453
+ * @public
454
+ * <p>Storage configuration name. The value does not need to be unique.</p>
320
455
  */
321
- constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
456
+ name?: string;
457
+ /**
458
+ * @public
459
+ * <p>A complex type that contains a storage configuration for where recorded video will be stored.</p>
460
+ */
461
+ s3: S3StorageConfiguration | undefined;
462
+ /**
463
+ * @public
464
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
465
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
466
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
467
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
468
+ * there.</p>
469
+ */
470
+ tags?: Record<string, string>;
471
+ }
472
+ /**
473
+ * @public
474
+ * <p>A complex type that describes a location where recorded videos will be stored.</p>
475
+ */
476
+ export interface StorageConfiguration {
477
+ /**
478
+ * @public
479
+ * <p>ARN of the storage configuration.</p>
480
+ */
481
+ arn: string | undefined;
482
+ /**
483
+ * @public
484
+ * <p>Name of the storage configuration.</p>
485
+ */
486
+ name?: string;
487
+ /**
488
+ * @public
489
+ * <p>An S3 destination configuration where recorded videos will be stored.</p>
490
+ */
491
+ s3?: S3StorageConfiguration;
492
+ /**
493
+ * @public
494
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
495
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
496
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
497
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
498
+ * there.</p>
499
+ */
500
+ tags?: Record<string, string>;
501
+ }
502
+ /**
503
+ * @public
504
+ */
505
+ export interface CreateStorageConfigurationResponse {
506
+ /**
507
+ * @public
508
+ * <p>The StorageConfiguration that was created.</p>
509
+ */
510
+ storageConfiguration?: StorageConfiguration;
511
+ }
512
+ /**
513
+ * @public
514
+ */
515
+ export interface DeleteEncoderConfigurationRequest {
516
+ /**
517
+ * @public
518
+ * <p>ARN of the EncoderConfiguration.</p>
519
+ */
520
+ arn: string | undefined;
521
+ }
522
+ /**
523
+ * @public
524
+ */
525
+ export interface DeleteEncoderConfigurationResponse {
322
526
  }
323
527
  /**
324
528
  * @public
@@ -335,6 +539,21 @@ export interface DeleteStageRequest {
335
539
  */
336
540
  export interface DeleteStageResponse {
337
541
  }
542
+ /**
543
+ * @public
544
+ */
545
+ export interface DeleteStorageConfigurationRequest {
546
+ /**
547
+ * @public
548
+ * <p>ARN of the storage configuration to be deleted.</p>
549
+ */
550
+ arn: string | undefined;
551
+ }
552
+ /**
553
+ * @public
554
+ */
555
+ export interface DeleteStorageConfigurationResponse {
556
+ }
338
557
  /**
339
558
  * @public
340
559
  */
@@ -346,20 +565,317 @@ export interface DisconnectParticipantRequest {
346
565
  stageArn: string | undefined;
347
566
  /**
348
567
  * @public
349
- * <p>Identifier of the participant to be disconnected. This is assigned by IVS and returned
350
- * by <a>CreateParticipantToken</a>.</p>
568
+ * <p>Identifier of the participant to be disconnected. This is assigned by IVS and returned
569
+ * by <a>CreateParticipantToken</a>.</p>
570
+ */
571
+ participantId: string | undefined;
572
+ /**
573
+ * @public
574
+ * <p>Description of why this participant is being disconnected.</p>
575
+ */
576
+ reason?: string;
577
+ }
578
+ /**
579
+ * @public
580
+ */
581
+ export interface DisconnectParticipantResponse {
582
+ }
583
+ /**
584
+ * @public
585
+ */
586
+ export interface GetCompositionRequest {
587
+ /**
588
+ * @public
589
+ * <p>ARN of the Composition resource.</p>
590
+ */
591
+ arn: string | undefined;
592
+ }
593
+ /**
594
+ * @public
595
+ * <p>Object specifying a channel as a destination.</p>
596
+ */
597
+ export interface ChannelDestinationConfiguration {
598
+ /**
599
+ * @public
600
+ * <p>ARN of the channel to use for broadcasting. The channel and stage resources must be in
601
+ * the same AWS account and region. The channel must be offline (not broadcasting).</p>
602
+ */
603
+ channelArn: string | undefined;
604
+ /**
605
+ * @public
606
+ * <p>ARN of the <a>EncoderConfiguration</a> resource. The encoder configuration
607
+ * and stage resources must be in the same AWS account and region.</p>
608
+ */
609
+ encoderConfigurationArn?: string;
610
+ }
611
+ /**
612
+ * @public
613
+ * @enum
614
+ */
615
+ export declare const RecordingConfigurationFormat: {
616
+ readonly HLS: "HLS";
617
+ };
618
+ /**
619
+ * @public
620
+ */
621
+ export type RecordingConfigurationFormat = (typeof RecordingConfigurationFormat)[keyof typeof RecordingConfigurationFormat];
622
+ /**
623
+ * @public
624
+ * <p>An object representing a configuration to record a stage stream.</p>
625
+ */
626
+ export interface RecordingConfiguration {
627
+ /**
628
+ * @public
629
+ * <p>The recording format for storing a recording in Amazon S3.</p>
630
+ */
631
+ format?: RecordingConfigurationFormat;
632
+ }
633
+ /**
634
+ * @public
635
+ * <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
636
+ */
637
+ export interface S3DestinationConfiguration {
638
+ /**
639
+ * @public
640
+ * <p>ARN of the <a>StorageConfiguration</a> where recorded videos will be stored.</p>
641
+ */
642
+ storageConfigurationArn: string | undefined;
643
+ /**
644
+ * @public
645
+ * <p>ARNs of the <a>EncoderConfiguration</a> resource. The encoder configuration and stage resources
646
+ * must be in the same AWS account and region. </p>
647
+ */
648
+ encoderConfigurationArns: string[] | undefined;
649
+ /**
650
+ * @public
651
+ * <p>Array of maps, each of the form <code>string:string (key:value)</code>.
652
+ * This is an optional customer specification, currently used only to specify
653
+ * the recording format for storing a recording in Amazon S3.</p>
654
+ */
655
+ recordingConfiguration?: RecordingConfiguration;
656
+ }
657
+ /**
658
+ * @public
659
+ * <p>Complex data type that defines destination-configuration objects.</p>
660
+ */
661
+ export interface DestinationConfiguration {
662
+ /**
663
+ * @public
664
+ * <p>Name that can be specified to help identify the destination.</p>
665
+ */
666
+ name?: string;
667
+ /**
668
+ * @public
669
+ * <p>An IVS channel to be used for broadcasting, for server-side composition. Either a <code>channel</code> or an
670
+ * <code>s3</code> must be specified. </p>
671
+ */
672
+ channel?: ChannelDestinationConfiguration;
673
+ /**
674
+ * @public
675
+ * <p>An S3 storage configuration to be used for recording video data. Either a <code>channel</code>
676
+ * or an <code>s3</code> must be specified.</p>
677
+ */
678
+ s3?: S3DestinationConfiguration;
679
+ }
680
+ /**
681
+ * @public
682
+ * <p>Complex data type that defines S3Detail objects.</p>
683
+ */
684
+ export interface S3Detail {
685
+ /**
686
+ * @public
687
+ * <p>The S3 bucket prefix under which the recording is stored.</p>
688
+ */
689
+ recordingPrefix: string | undefined;
690
+ }
691
+ /**
692
+ * @public
693
+ * <p>Complex data type that defines destination-detail objects.</p>
694
+ */
695
+ export interface DestinationDetail {
696
+ /**
697
+ * @public
698
+ * <p>An S3 detail object to return information about the S3 destination.</p>
699
+ */
700
+ s3?: S3Detail;
701
+ }
702
+ /**
703
+ * @public
704
+ * @enum
705
+ */
706
+ export declare const DestinationState: {
707
+ readonly ACTIVE: "ACTIVE";
708
+ readonly FAILED: "FAILED";
709
+ readonly RECONNECTING: "RECONNECTING";
710
+ readonly STARTING: "STARTING";
711
+ readonly STOPPED: "STOPPED";
712
+ readonly STOPPING: "STOPPING";
713
+ };
714
+ /**
715
+ * @public
716
+ */
717
+ export type DestinationState = (typeof DestinationState)[keyof typeof DestinationState];
718
+ /**
719
+ * @public
720
+ * <p>Object specifying the status of a Destination.</p>
721
+ */
722
+ export interface Destination {
723
+ /**
724
+ * @public
725
+ * <p>Unique identifier for this destination, assigned by IVS.</p>
726
+ */
727
+ id: string | undefined;
728
+ /**
729
+ * @public
730
+ * <p>State of the Composition Destination.</p>
731
+ */
732
+ state: DestinationState | undefined;
733
+ /**
734
+ * @public
735
+ * <p>UTC time of the destination start. This is an ISO 8601 timestamp; <i>note that
736
+ * this is returned as a string</i>.</p>
737
+ */
738
+ startTime?: Date;
739
+ /**
740
+ * @public
741
+ * <p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this
742
+ * is returned as a string</i>.</p>
743
+ */
744
+ endTime?: Date;
745
+ /**
746
+ * @public
747
+ * <p>Configuration used to create this destination.</p>
748
+ */
749
+ configuration: DestinationConfiguration | undefined;
750
+ /**
751
+ * @public
752
+ * <p>Optional details regarding the status of the destination.</p>
753
+ */
754
+ detail?: DestinationDetail;
755
+ }
756
+ /**
757
+ * @public
758
+ * <p>Configuration information specific to Grid layout, for server-side composition. See
759
+ * "Layouts" in <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html">Server-Side
760
+ * Composition</a>.</p>
761
+ */
762
+ export interface GridConfiguration {
763
+ /**
764
+ * @public
765
+ * <p>This attribute name identifies the featured slot. A participant with this attribute set
766
+ * to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured
767
+ * slot.</p>
768
+ */
769
+ featuredParticipantAttribute?: string;
770
+ }
771
+ /**
772
+ * @public
773
+ * <p>Configuration information of supported layouts for server-side composition.</p>
774
+ */
775
+ export interface LayoutConfiguration {
776
+ /**
777
+ * @public
778
+ * <p>Configuration related to grid layout. Default: Grid layout.</p>
779
+ */
780
+ grid?: GridConfiguration;
781
+ }
782
+ /**
783
+ * @public
784
+ * @enum
785
+ */
786
+ export declare const CompositionState: {
787
+ readonly ACTIVE: "ACTIVE";
788
+ readonly FAILED: "FAILED";
789
+ readonly STARTING: "STARTING";
790
+ readonly STOPPED: "STOPPED";
791
+ readonly STOPPING: "STOPPING";
792
+ };
793
+ /**
794
+ * @public
795
+ */
796
+ export type CompositionState = (typeof CompositionState)[keyof typeof CompositionState];
797
+ /**
798
+ * @public
799
+ * <p>Object specifying a Composition resource.</p>
800
+ */
801
+ export interface Composition {
802
+ /**
803
+ * @public
804
+ * <p>ARN of the Composition resource.</p>
805
+ */
806
+ arn: string | undefined;
807
+ /**
808
+ * @public
809
+ * <p>ARN of the stage used as input</p>
810
+ */
811
+ stageArn: string | undefined;
812
+ /**
813
+ * @public
814
+ * <p>State of the Composition.</p>
815
+ */
816
+ state: CompositionState | undefined;
817
+ /**
818
+ * @public
819
+ * <p>Layout object to configure composition parameters.</p>
820
+ */
821
+ layout: LayoutConfiguration | undefined;
822
+ /**
823
+ * @public
824
+ * <p>Array of Destination objects. A Composition can contain either one destination
825
+ * (<code>channel</code> or <code>s3</code>) or two (one <code>channel</code> and one <code>s3</code>).</p>
826
+ */
827
+ destinations: Destination[] | undefined;
828
+ /**
829
+ * @public
830
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
831
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
832
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
833
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
834
+ * there.</p>
835
+ */
836
+ tags?: Record<string, string>;
837
+ /**
838
+ * @public
839
+ * <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
840
+ * this is returned as a string</i>.</p>
841
+ */
842
+ startTime?: Date;
843
+ /**
844
+ * @public
845
+ * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that
846
+ * this is returned as a string</i>.</p>
847
+ */
848
+ endTime?: Date;
849
+ }
850
+ /**
851
+ * @public
852
+ */
853
+ export interface GetCompositionResponse {
854
+ /**
855
+ * @public
856
+ * <p>The Composition that was returned.</p>
351
857
  */
352
- participantId: string | undefined;
858
+ composition?: Composition;
859
+ }
860
+ /**
861
+ * @public
862
+ */
863
+ export interface GetEncoderConfigurationRequest {
353
864
  /**
354
865
  * @public
355
- * <p>Description of why this participant is being disconnected.</p>
866
+ * <p>ARN of the EncoderConfiguration resource.</p>
356
867
  */
357
- reason?: string;
868
+ arn: string | undefined;
358
869
  }
359
870
  /**
360
871
  * @public
361
872
  */
362
- export interface DisconnectParticipantResponse {
873
+ export interface GetEncoderConfigurationResponse {
874
+ /**
875
+ * @public
876
+ * <p>The EncoderConfiguration that was returned.</p>
877
+ */
878
+ encoderConfiguration?: EncoderConfiguration;
363
879
  }
364
880
  /**
365
881
  * @public
@@ -546,6 +1062,201 @@ export interface GetStageSessionResponse {
546
1062
  */
547
1063
  stageSession?: StageSession;
548
1064
  }
1065
+ /**
1066
+ * @public
1067
+ */
1068
+ export interface GetStorageConfigurationRequest {
1069
+ /**
1070
+ * @public
1071
+ * <p>ARN of the storage configuration to be retrieved.</p>
1072
+ */
1073
+ arn: string | undefined;
1074
+ }
1075
+ /**
1076
+ * @public
1077
+ */
1078
+ export interface GetStorageConfigurationResponse {
1079
+ /**
1080
+ * @public
1081
+ * <p>The StorageConfiguration that was returned.</p>
1082
+ */
1083
+ storageConfiguration?: StorageConfiguration;
1084
+ }
1085
+ /**
1086
+ * @public
1087
+ */
1088
+ export interface ListCompositionsRequest {
1089
+ /**
1090
+ * @public
1091
+ * <p>Filters the Composition list to match the specified Stage ARN.</p>
1092
+ */
1093
+ filterByStageArn?: string;
1094
+ /**
1095
+ * @public
1096
+ * <p>Filters the Composition list to match the specified EncoderConfiguration attached to at
1097
+ * least one of its output.</p>
1098
+ */
1099
+ filterByEncoderConfigurationArn?: string;
1100
+ /**
1101
+ * @public
1102
+ * <p>The first Composition to retrieve. This is used for pagination; see the
1103
+ * <code>nextToken</code> response field.</p>
1104
+ */
1105
+ nextToken?: string;
1106
+ /**
1107
+ * @public
1108
+ * <p>Maximum number of results to return. Default: 100.</p>
1109
+ */
1110
+ maxResults?: number;
1111
+ }
1112
+ /**
1113
+ * @public
1114
+ * <p>Summary information about a Destination.</p>
1115
+ */
1116
+ export interface DestinationSummary {
1117
+ /**
1118
+ * @public
1119
+ * <p>Unique identifier for this destination, assigned by IVS.</p>
1120
+ */
1121
+ id: string | undefined;
1122
+ /**
1123
+ * @public
1124
+ * <p>State of the Composition Destination.</p>
1125
+ */
1126
+ state: DestinationState | undefined;
1127
+ /**
1128
+ * @public
1129
+ * <p>UTC time of the destination start. This is an ISO 8601 timestamp; <i>note that
1130
+ * this is returned as a string</i>.</p>
1131
+ */
1132
+ startTime?: Date;
1133
+ /**
1134
+ * @public
1135
+ * <p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this
1136
+ * is returned as a string</i>.</p>
1137
+ */
1138
+ endTime?: Date;
1139
+ }
1140
+ /**
1141
+ * @public
1142
+ * <p>Summary information about a Composition.</p>
1143
+ */
1144
+ export interface CompositionSummary {
1145
+ /**
1146
+ * @public
1147
+ * <p>ARN of the Composition resource.</p>
1148
+ */
1149
+ arn: string | undefined;
1150
+ /**
1151
+ * @public
1152
+ * <p>ARN of the attached stage.</p>
1153
+ */
1154
+ stageArn: string | undefined;
1155
+ /**
1156
+ * @public
1157
+ * <p>Array of Destination objects.</p>
1158
+ */
1159
+ destinations: DestinationSummary[] | undefined;
1160
+ /**
1161
+ * @public
1162
+ * <p>State of the Composition resource.</p>
1163
+ */
1164
+ state: CompositionState | undefined;
1165
+ /**
1166
+ * @public
1167
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1168
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
1169
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
1170
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1171
+ * there.</p>
1172
+ */
1173
+ tags?: Record<string, string>;
1174
+ /**
1175
+ * @public
1176
+ * <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
1177
+ * this is returned as a string</i>.</p>
1178
+ */
1179
+ startTime?: Date;
1180
+ /**
1181
+ * @public
1182
+ * <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that
1183
+ * this is returned as a string</i>.</p>
1184
+ */
1185
+ endTime?: Date;
1186
+ }
1187
+ /**
1188
+ * @public
1189
+ */
1190
+ export interface ListCompositionsResponse {
1191
+ /**
1192
+ * @public
1193
+ * <p>List of the matching Compositions (summary information only).</p>
1194
+ */
1195
+ compositions: CompositionSummary[] | undefined;
1196
+ /**
1197
+ * @public
1198
+ * <p>If there are more compositions than <code>maxResults</code>, use <code>nextToken</code>
1199
+ * in the request to get the next set.</p>
1200
+ */
1201
+ nextToken?: string;
1202
+ }
1203
+ /**
1204
+ * @public
1205
+ */
1206
+ export interface ListEncoderConfigurationsRequest {
1207
+ /**
1208
+ * @public
1209
+ * <p>The first encoder configuration to retrieve. This is used for pagination; see the
1210
+ * <code>nextToken</code> response field.</p>
1211
+ */
1212
+ nextToken?: string;
1213
+ /**
1214
+ * @public
1215
+ * <p>Maximum number of results to return. Default: 100.</p>
1216
+ */
1217
+ maxResults?: number;
1218
+ }
1219
+ /**
1220
+ * @public
1221
+ * <p>Summary information about an EncoderConfiguration.</p>
1222
+ */
1223
+ export interface EncoderConfigurationSummary {
1224
+ /**
1225
+ * @public
1226
+ * <p>ARN of the EncoderConfiguration resource.</p>
1227
+ */
1228
+ arn: string | undefined;
1229
+ /**
1230
+ * @public
1231
+ * <p>Optional name to identify the resource.</p>
1232
+ */
1233
+ name?: string;
1234
+ /**
1235
+ * @public
1236
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1237
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
1238
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
1239
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1240
+ * there.</p>
1241
+ */
1242
+ tags?: Record<string, string>;
1243
+ }
1244
+ /**
1245
+ * @public
1246
+ */
1247
+ export interface ListEncoderConfigurationsResponse {
1248
+ /**
1249
+ * @public
1250
+ * <p>List of the matching EncoderConfigurations (summary information only).</p>
1251
+ */
1252
+ encoderConfigurations: EncoderConfigurationSummary[] | undefined;
1253
+ /**
1254
+ * @public
1255
+ * <p>If there are more encoder configurations than <code>maxResults</code>, use
1256
+ * <code>nextToken</code> in the request to get the next set.</p>
1257
+ */
1258
+ nextToken?: string;
1259
+ }
549
1260
  /**
550
1261
  * @public
551
1262
  */
@@ -567,7 +1278,7 @@ export interface ListParticipantEventsRequest {
567
1278
  participantId: string | undefined;
568
1279
  /**
569
1280
  * @public
570
- * <p>The first participant to retrieve. This is used for pagination; see the
1281
+ * <p>The first participant event to retrieve. This is used for pagination; see the
571
1282
  * <code>nextToken</code> response field.</p>
572
1283
  */
573
1284
  nextToken?: string;
@@ -661,7 +1372,7 @@ export interface ListParticipantEventsResponse {
661
1372
  events: Event[] | undefined;
662
1373
  /**
663
1374
  * @public
664
- * <p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the
1375
+ * <p>If there are more events than <code>maxResults</code>, use <code>nextToken</code> in the
665
1376
  * request to get the next set. </p>
666
1377
  */
667
1378
  nextToken?: string;
@@ -761,8 +1472,8 @@ export interface ListParticipantsResponse {
761
1472
  participants: ParticipantSummary[] | undefined;
762
1473
  /**
763
1474
  * @public
764
- * <p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the
765
- * request to get the next set.</p>
1475
+ * <p>If there are more participants than <code>maxResults</code>, use <code>nextToken</code>
1476
+ * in the request to get the next set.</p>
766
1477
  */
767
1478
  nextToken?: string;
768
1479
  }
@@ -823,7 +1534,7 @@ export interface ListStagesResponse {
823
1534
  stages: StageSummary[] | undefined;
824
1535
  /**
825
1536
  * @public
826
- * <p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the
1537
+ * <p>If there are more stages than <code>maxResults</code>, use <code>nextToken</code> in the
827
1538
  * request to get the next set.</p>
828
1539
  */
829
1540
  nextToken?: string;
@@ -839,8 +1550,8 @@ export interface ListStageSessionsRequest {
839
1550
  stageArn: string | undefined;
840
1551
  /**
841
1552
  * @public
842
- * <p>The first stage to retrieve. This is used for pagination; see the <code>nextToken</code>
843
- * response field.</p>
1553
+ * <p>The first stage session to retrieve. This is used for pagination; see the
1554
+ * <code>nextToken</code> response field.</p>
844
1555
  */
845
1556
  nextToken?: string;
846
1557
  /**
@@ -882,27 +1593,73 @@ export interface ListStageSessionsResponse {
882
1593
  stageSessions: StageSessionSummary[] | undefined;
883
1594
  /**
884
1595
  * @public
885
- * <p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the
886
- * request to get the next set.</p>
1596
+ * <p>If there are more stage sessions than <code>maxResults</code>, use
1597
+ * <code>nextToken</code> in the request to get the next set.</p>
887
1598
  */
888
1599
  nextToken?: string;
889
1600
  }
890
1601
  /**
891
1602
  * @public
892
- * <p/>
893
1603
  */
894
- export declare class InternalServerException extends __BaseException {
895
- readonly name: "InternalServerException";
896
- readonly $fault: "server";
1604
+ export interface ListStorageConfigurationsRequest {
897
1605
  /**
898
1606
  * @public
899
- * <p>Unexpected error during processing of request.</p>
1607
+ * <p>The first storage configuration to retrieve. This is used for pagination;
1608
+ * see the <code>nextToken</code> response field.</p>
900
1609
  */
901
- exceptionMessage?: string;
1610
+ nextToken?: string;
902
1611
  /**
903
- * @internal
1612
+ * @public
1613
+ * <p>Maximum number of storage configurations to return. Default: your service quota or 100,
1614
+ * whichever is smaller.</p>
904
1615
  */
905
- constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
1616
+ maxResults?: number;
1617
+ }
1618
+ /**
1619
+ * @public
1620
+ * <p>Summary information about a storage configuration.</p>
1621
+ */
1622
+ export interface StorageConfigurationSummary {
1623
+ /**
1624
+ * @public
1625
+ * <p>ARN of the storage configuration.</p>
1626
+ */
1627
+ arn: string | undefined;
1628
+ /**
1629
+ * @public
1630
+ * <p>Name of the storage configuration.</p>
1631
+ */
1632
+ name?: string;
1633
+ /**
1634
+ * @public
1635
+ * <p>An S3 destination configuration where recorded videos will be stored.</p>
1636
+ */
1637
+ s3?: S3StorageConfiguration;
1638
+ /**
1639
+ * @public
1640
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1641
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
1642
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
1643
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1644
+ * there.</p>
1645
+ */
1646
+ tags?: Record<string, string>;
1647
+ }
1648
+ /**
1649
+ * @public
1650
+ */
1651
+ export interface ListStorageConfigurationsResponse {
1652
+ /**
1653
+ * @public
1654
+ * <p>List of the matching storage configurations.</p>
1655
+ */
1656
+ storageConfigurations: StorageConfigurationSummary[] | undefined;
1657
+ /**
1658
+ * @public
1659
+ * <p>If there are more storage configurations than <code>maxResults</code>, use <code>nextToken</code>
1660
+ * in the request to get the next set.</p>
1661
+ */
1662
+ nextToken?: string;
906
1663
  }
907
1664
  /**
908
1665
  * @public
@@ -925,6 +1682,65 @@ export interface ListTagsForResourceResponse {
925
1682
  */
926
1683
  tags: Record<string, string> | undefined;
927
1684
  }
1685
+ /**
1686
+ * @public
1687
+ */
1688
+ export interface StartCompositionRequest {
1689
+ /**
1690
+ * @public
1691
+ * <p>ARN of the stage to be used for compositing.</p>
1692
+ */
1693
+ stageArn: string | undefined;
1694
+ /**
1695
+ * @public
1696
+ * <p>Idempotency token.</p>
1697
+ */
1698
+ idempotencyToken?: string;
1699
+ /**
1700
+ * @public
1701
+ * <p>Layout object to configure composition parameters.</p>
1702
+ */
1703
+ layout?: LayoutConfiguration;
1704
+ /**
1705
+ * @public
1706
+ * <p>Array of destination configuration.</p>
1707
+ */
1708
+ destinations: DestinationConfiguration[] | undefined;
1709
+ /**
1710
+ * @public
1711
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1712
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
1713
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
1714
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
1715
+ * there.</p>
1716
+ */
1717
+ tags?: Record<string, string>;
1718
+ }
1719
+ /**
1720
+ * @public
1721
+ */
1722
+ export interface StartCompositionResponse {
1723
+ /**
1724
+ * @public
1725
+ * <p>The Composition that was created.</p>
1726
+ */
1727
+ composition?: Composition;
1728
+ }
1729
+ /**
1730
+ * @public
1731
+ */
1732
+ export interface StopCompositionRequest {
1733
+ /**
1734
+ * @public
1735
+ * <p>ARN of the Composition.</p>
1736
+ */
1737
+ arn: string | undefined;
1738
+ }
1739
+ /**
1740
+ * @public
1741
+ */
1742
+ export interface StopCompositionResponse {
1743
+ }
928
1744
  /**
929
1745
  * @public
930
1746
  */