aws-sdk 2.1645.0 → 2.1646.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/apis/bedrock-runtime-2023-09-30.min.json +72 -45
- package/apis/codeartifact-2018-09-22.min.json +7 -1
- package/apis/compute-optimizer-2019-11-01.min.json +447 -134
- package/apis/cost-optimization-hub-2022-07-26.min.json +310 -262
- package/apis/cost-optimization-hub-2022-07-26.waiters2.json +5 -0
- package/apis/dynamodb-2011-12-05.min.json +4 -1
- package/apis/dynamodb-2012-08-10.min.json +4 -1
- package/apis/glue-2017-03-31.paginators.json +16 -8
- package/apis/ivs-realtime-2020-07-14.min.json +272 -245
- package/apis/ivs-realtime-2020-07-14.waiters2.json +5 -0
- package/apis/sagemaker-2017-07-24.min.json +1261 -1207
- package/apis/securityhub-2018-10-26.min.json +4 -1
- package/clients/bedrockruntime.d.ts +31 -0
- package/clients/codeartifact.d.ts +28 -28
- package/clients/computeoptimizer.d.ts +449 -47
- package/clients/costoptimizationhub.d.ts +380 -328
- package/clients/costoptimizationhub.js +1 -0
- package/clients/dynamodb.d.ts +12 -12
- package/clients/ivsrealtime.d.ts +282 -233
- package/clients/ivsrealtime.js +1 -0
- package/clients/sagemaker.d.ts +134 -34
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +336 -322
- package/dist/aws-sdk.js +11 -5
- package/dist/aws-sdk.min.js +5 -5
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/ivsrealtime.d.ts
CHANGED
@@ -230,6 +230,17 @@ declare class IVSRealTime extends Service {
|
|
230
230
|
}
|
231
231
|
declare namespace IVSRealTime {
|
232
232
|
export type AttributeKey = string;
|
233
|
+
export interface AutoParticipantRecordingConfiguration {
|
234
|
+
/**
|
235
|
+
* ARN of the StorageConfiguration resource to use for auto participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.
|
236
|
+
*/
|
237
|
+
storageConfigurationArn: AutoParticipantRecordingStorageConfigurationArn;
|
238
|
+
/**
|
239
|
+
* Types of media to be recorded. Default: AUDIO_VIDEO.
|
240
|
+
*/
|
241
|
+
mediaTypes?: ParticipantRecordingMediaTypeList;
|
242
|
+
}
|
243
|
+
export type AutoParticipantRecordingStorageConfigurationArn = string;
|
233
244
|
export type Bitrate = number;
|
234
245
|
export type ChannelArn = string;
|
235
246
|
export interface ChannelDestinationConfiguration {
|
@@ -248,33 +259,33 @@ declare namespace IVSRealTime {
|
|
248
259
|
*/
|
249
260
|
arn: CompositionArn;
|
250
261
|
/**
|
251
|
-
*
|
262
|
+
* ARN of the stage used as input
|
252
263
|
*/
|
253
|
-
|
264
|
+
stageArn: StageArn;
|
254
265
|
/**
|
255
|
-
*
|
266
|
+
* State of the Composition.
|
256
267
|
*/
|
257
|
-
|
268
|
+
state: CompositionState;
|
258
269
|
/**
|
259
270
|
* Layout object to configure composition parameters.
|
260
271
|
*/
|
261
272
|
layout: LayoutConfiguration;
|
262
273
|
/**
|
263
|
-
*
|
274
|
+
* Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).
|
264
275
|
*/
|
265
|
-
|
276
|
+
destinations: DestinationList;
|
266
277
|
/**
|
267
|
-
*
|
278
|
+
* Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
|
268
279
|
*/
|
269
|
-
|
280
|
+
tags?: Tags;
|
270
281
|
/**
|
271
|
-
*
|
282
|
+
* UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
|
272
283
|
*/
|
273
|
-
|
284
|
+
startTime?: Time;
|
274
285
|
/**
|
275
|
-
*
|
286
|
+
* UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
|
276
287
|
*/
|
277
|
-
|
288
|
+
endTime?: Time;
|
278
289
|
}
|
279
290
|
export type CompositionArn = string;
|
280
291
|
export type CompositionClientToken = string;
|
@@ -284,22 +295,14 @@ declare namespace IVSRealTime {
|
|
284
295
|
* ARN of the Composition resource.
|
285
296
|
*/
|
286
297
|
arn: CompositionArn;
|
287
|
-
/**
|
288
|
-
* Array of Destination objects.
|
289
|
-
*/
|
290
|
-
destinations: DestinationSummaryList;
|
291
|
-
/**
|
292
|
-
* UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
|
293
|
-
*/
|
294
|
-
endTime?: Time;
|
295
298
|
/**
|
296
299
|
* ARN of the attached stage.
|
297
300
|
*/
|
298
301
|
stageArn: StageArn;
|
299
302
|
/**
|
300
|
-
*
|
303
|
+
* Array of Destination objects.
|
301
304
|
*/
|
302
|
-
|
305
|
+
destinations: DestinationSummaryList;
|
303
306
|
/**
|
304
307
|
* State of the Composition resource.
|
305
308
|
*/
|
@@ -308,6 +311,14 @@ declare namespace IVSRealTime {
|
|
308
311
|
* Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
|
309
312
|
*/
|
310
313
|
tags?: Tags;
|
314
|
+
/**
|
315
|
+
* UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
|
316
|
+
*/
|
317
|
+
startTime?: Time;
|
318
|
+
/**
|
319
|
+
* UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
|
320
|
+
*/
|
321
|
+
endTime?: Time;
|
311
322
|
}
|
312
323
|
export type CompositionSummaryList = CompositionSummary[];
|
313
324
|
export interface CreateEncoderConfigurationRequest {
|
@@ -315,14 +326,14 @@ declare namespace IVSRealTime {
|
|
315
326
|
* Optional name to identify the resource.
|
316
327
|
*/
|
317
328
|
name?: EncoderConfigurationName;
|
318
|
-
/**
|
319
|
-
* Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
|
320
|
-
*/
|
321
|
-
tags?: Tags;
|
322
329
|
/**
|
323
330
|
* Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.
|
324
331
|
*/
|
325
332
|
video?: Video;
|
333
|
+
/**
|
334
|
+
* Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
|
335
|
+
*/
|
336
|
+
tags?: Tags;
|
326
337
|
}
|
327
338
|
export interface CreateEncoderConfigurationResponse {
|
328
339
|
/**
|
@@ -332,25 +343,25 @@ declare namespace IVSRealTime {
|
|
332
343
|
}
|
333
344
|
export interface CreateParticipantTokenRequest {
|
334
345
|
/**
|
335
|
-
*
|
336
|
-
*/
|
337
|
-
attributes?: ParticipantTokenAttributes;
|
338
|
-
/**
|
339
|
-
* Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.
|
346
|
+
* ARN of the stage to which this token is scoped.
|
340
347
|
*/
|
341
|
-
|
348
|
+
stageArn: StageArn;
|
342
349
|
/**
|
343
350
|
* Duration (in minutes), after which the token expires. Default: 720 (12 hours).
|
344
351
|
*/
|
345
352
|
duration?: ParticipantTokenDurationMinutes;
|
346
|
-
/**
|
347
|
-
* ARN of the stage to which this token is scoped.
|
348
|
-
*/
|
349
|
-
stageArn: StageArn;
|
350
353
|
/**
|
351
354
|
* Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
352
355
|
*/
|
353
356
|
userId?: ParticipantTokenUserId;
|
357
|
+
/**
|
358
|
+
* Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
359
|
+
*/
|
360
|
+
attributes?: ParticipantTokenAttributes;
|
361
|
+
/**
|
362
|
+
* Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.
|
363
|
+
*/
|
364
|
+
capabilities?: ParticipantTokenCapabilities;
|
354
365
|
}
|
355
366
|
export interface CreateParticipantTokenResponse {
|
356
367
|
/**
|
@@ -371,16 +382,20 @@ declare namespace IVSRealTime {
|
|
371
382
|
* Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
|
372
383
|
*/
|
373
384
|
tags?: Tags;
|
374
|
-
}
|
375
|
-
export interface CreateStageResponse {
|
376
385
|
/**
|
377
|
-
*
|
386
|
+
* Auto participant recording configuration object attached to the stage.
|
378
387
|
*/
|
379
|
-
|
388
|
+
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
|
389
|
+
}
|
390
|
+
export interface CreateStageResponse {
|
380
391
|
/**
|
381
392
|
* The stage that was created.
|
382
393
|
*/
|
383
394
|
stage?: Stage;
|
395
|
+
/**
|
396
|
+
* Participant tokens attached to the stage. These correspond to the participants in the request.
|
397
|
+
*/
|
398
|
+
participantTokens?: ParticipantTokenList;
|
384
399
|
}
|
385
400
|
export interface CreateStorageConfigurationRequest {
|
386
401
|
/**
|
@@ -428,39 +443,39 @@ declare namespace IVSRealTime {
|
|
428
443
|
}
|
429
444
|
export interface Destination {
|
430
445
|
/**
|
431
|
-
*
|
446
|
+
* Unique identifier for this destination, assigned by IVS.
|
432
447
|
*/
|
433
|
-
|
448
|
+
id: String;
|
434
449
|
/**
|
435
|
-
*
|
450
|
+
* State of the Composition Destination.
|
436
451
|
*/
|
437
|
-
|
452
|
+
state: DestinationState;
|
438
453
|
/**
|
439
|
-
* UTC time of the destination
|
454
|
+
* UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
|
440
455
|
*/
|
441
|
-
|
456
|
+
startTime?: Time;
|
442
457
|
/**
|
443
|
-
*
|
458
|
+
* UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
|
444
459
|
*/
|
445
|
-
|
460
|
+
endTime?: Time;
|
446
461
|
/**
|
447
|
-
*
|
462
|
+
* Configuration used to create this destination.
|
448
463
|
*/
|
449
|
-
|
464
|
+
configuration: DestinationConfiguration;
|
450
465
|
/**
|
451
|
-
*
|
466
|
+
* Optional details regarding the status of the destination.
|
452
467
|
*/
|
453
|
-
|
468
|
+
detail?: DestinationDetail;
|
454
469
|
}
|
455
470
|
export interface DestinationConfiguration {
|
456
|
-
/**
|
457
|
-
* An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.
|
458
|
-
*/
|
459
|
-
channel?: ChannelDestinationConfiguration;
|
460
471
|
/**
|
461
472
|
* Name that can be specified to help identify the destination.
|
462
473
|
*/
|
463
474
|
name?: DestinationConfigurationName;
|
475
|
+
/**
|
476
|
+
* An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.
|
477
|
+
*/
|
478
|
+
channel?: ChannelDestinationConfiguration;
|
464
479
|
/**
|
465
480
|
* An S3 storage configuration to be used for recording video data. Either a channel or an s3 must be specified.
|
466
481
|
*/
|
@@ -477,26 +492,30 @@ declare namespace IVSRealTime {
|
|
477
492
|
export type DestinationList = Destination[];
|
478
493
|
export type DestinationState = "STARTING"|"ACTIVE"|"STOPPING"|"RECONNECTING"|"FAILED"|"STOPPED"|string;
|
479
494
|
export interface DestinationSummary {
|
480
|
-
/**
|
481
|
-
* UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
|
482
|
-
*/
|
483
|
-
endTime?: Time;
|
484
495
|
/**
|
485
496
|
* Unique identifier for this destination, assigned by IVS.
|
486
497
|
*/
|
487
498
|
id: String;
|
499
|
+
/**
|
500
|
+
* State of the Composition Destination.
|
501
|
+
*/
|
502
|
+
state: DestinationState;
|
488
503
|
/**
|
489
504
|
* UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
|
490
505
|
*/
|
491
506
|
startTime?: Time;
|
492
507
|
/**
|
493
|
-
*
|
508
|
+
* UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
|
494
509
|
*/
|
495
|
-
|
510
|
+
endTime?: Time;
|
496
511
|
}
|
497
512
|
export type DestinationSummaryList = DestinationSummary[];
|
498
513
|
export type DisconnectParticipantReason = string;
|
499
514
|
export interface DisconnectParticipantRequest {
|
515
|
+
/**
|
516
|
+
* ARN of the stage to which the participant is attached.
|
517
|
+
*/
|
518
|
+
stageArn: StageArn;
|
500
519
|
/**
|
501
520
|
* Identifier of the participant to be disconnected. This is assigned by IVS and returned by CreateParticipantToken.
|
502
521
|
*/
|
@@ -505,10 +524,6 @@ declare namespace IVSRealTime {
|
|
505
524
|
* Description of why this participant is being disconnected.
|
506
525
|
*/
|
507
526
|
reason?: DisconnectParticipantReason;
|
508
|
-
/**
|
509
|
-
* ARN of the stage to which the participant is attached.
|
510
|
-
*/
|
511
|
-
stageArn: StageArn;
|
512
527
|
}
|
513
528
|
export interface DisconnectParticipantResponse {
|
514
529
|
}
|
@@ -521,14 +536,14 @@ declare namespace IVSRealTime {
|
|
521
536
|
* Optional name to identify the resource.
|
522
537
|
*/
|
523
538
|
name?: EncoderConfigurationName;
|
524
|
-
/**
|
525
|
-
* Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
|
526
|
-
*/
|
527
|
-
tags?: Tags;
|
528
539
|
/**
|
529
540
|
* Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
|
530
541
|
*/
|
531
542
|
video?: Video;
|
543
|
+
/**
|
544
|
+
* Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
|
545
|
+
*/
|
546
|
+
tags?: Tags;
|
532
547
|
}
|
533
548
|
export type EncoderConfigurationArn = string;
|
534
549
|
export type EncoderConfigurationArnList = EncoderConfigurationArn[];
|
@@ -549,14 +564,6 @@ declare namespace IVSRealTime {
|
|
549
564
|
}
|
550
565
|
export type EncoderConfigurationSummaryList = EncoderConfigurationSummary[];
|
551
566
|
export interface Event {
|
552
|
-
/**
|
553
|
-
* If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
|
554
|
-
*/
|
555
|
-
errorCode?: EventErrorCode;
|
556
|
-
/**
|
557
|
-
* ISO 8601 timestamp (returned as a string) for when the event occurred.
|
558
|
-
*/
|
559
|
-
eventTime?: Time;
|
560
567
|
/**
|
561
568
|
* The name of the event.
|
562
569
|
*/
|
@@ -565,10 +572,18 @@ declare namespace IVSRealTime {
|
|
565
572
|
* Unique identifier for the participant who triggered the event. This is assigned by IVS.
|
566
573
|
*/
|
567
574
|
participantId?: ParticipantId;
|
575
|
+
/**
|
576
|
+
* ISO 8601 timestamp (returned as a string) for when the event occurred.
|
577
|
+
*/
|
578
|
+
eventTime?: Time;
|
568
579
|
/**
|
569
580
|
* Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
|
570
581
|
*/
|
571
582
|
remoteParticipantId?: ParticipantId;
|
583
|
+
/**
|
584
|
+
* If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
|
585
|
+
*/
|
586
|
+
errorCode?: EventErrorCode;
|
572
587
|
}
|
573
588
|
export type EventErrorCode = "INSUFFICIENT_CAPABILITIES"|"QUOTA_EXCEEDED"|"PUBLISHER_NOT_FOUND"|string;
|
574
589
|
export type EventList = Event[];
|
@@ -600,17 +615,17 @@ declare namespace IVSRealTime {
|
|
600
615
|
}
|
601
616
|
export interface GetParticipantRequest {
|
602
617
|
/**
|
603
|
-
*
|
618
|
+
* Stage ARN.
|
604
619
|
*/
|
605
|
-
|
620
|
+
stageArn: StageArn;
|
606
621
|
/**
|
607
622
|
* ID of a session within the stage.
|
608
623
|
*/
|
609
624
|
sessionId: StageSessionId;
|
610
625
|
/**
|
611
|
-
*
|
626
|
+
* Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.
|
612
627
|
*/
|
613
|
-
|
628
|
+
participantId: ParticipantId;
|
614
629
|
}
|
615
630
|
export interface GetParticipantResponse {
|
616
631
|
/**
|
@@ -631,14 +646,14 @@ declare namespace IVSRealTime {
|
|
631
646
|
stage?: Stage;
|
632
647
|
}
|
633
648
|
export interface GetStageSessionRequest {
|
634
|
-
/**
|
635
|
-
* ID of a session within the stage.
|
636
|
-
*/
|
637
|
-
sessionId: StageSessionId;
|
638
649
|
/**
|
639
650
|
* ARN of the stage for which the information is to be retrieved.
|
640
651
|
*/
|
641
652
|
stageArn: StageArn;
|
653
|
+
/**
|
654
|
+
* ID of a session within the stage.
|
655
|
+
*/
|
656
|
+
sessionId: StageSessionId;
|
642
657
|
}
|
643
658
|
export interface GetStageSessionResponse {
|
644
659
|
/**
|
@@ -663,10 +678,6 @@ declare namespace IVSRealTime {
|
|
663
678
|
* This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.
|
664
679
|
*/
|
665
680
|
featuredParticipantAttribute?: AttributeKey;
|
666
|
-
/**
|
667
|
-
* Specifies the spacing between participant tiles in pixels. Default: 2.
|
668
|
-
*/
|
669
|
-
gridGap?: GridGap;
|
670
681
|
/**
|
671
682
|
* Determines whether to omit participants with stopped video in the composition. Default: false.
|
672
683
|
*/
|
@@ -679,6 +690,10 @@ declare namespace IVSRealTime {
|
|
679
690
|
* Defines how video fits within the participant tile. When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.
|
680
691
|
*/
|
681
692
|
videoFillMode?: VideoFillMode;
|
693
|
+
/**
|
694
|
+
* Specifies the spacing between participant tiles in pixels. Default: 2.
|
695
|
+
*/
|
696
|
+
gridGap?: GridGap;
|
682
697
|
}
|
683
698
|
export type GridGap = number;
|
684
699
|
export type Height = number;
|
@@ -693,22 +708,22 @@ declare namespace IVSRealTime {
|
|
693
708
|
pip?: PipConfiguration;
|
694
709
|
}
|
695
710
|
export interface ListCompositionsRequest {
|
696
|
-
/**
|
697
|
-
* Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.
|
698
|
-
*/
|
699
|
-
filterByEncoderConfigurationArn?: EncoderConfigurationArn;
|
700
711
|
/**
|
701
712
|
* Filters the Composition list to match the specified Stage ARN.
|
702
713
|
*/
|
703
714
|
filterByStageArn?: StageArn;
|
704
715
|
/**
|
705
|
-
*
|
716
|
+
* Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.
|
706
717
|
*/
|
707
|
-
|
718
|
+
filterByEncoderConfigurationArn?: EncoderConfigurationArn;
|
708
719
|
/**
|
709
720
|
* The first Composition to retrieve. This is used for pagination; see the nextToken response field.
|
710
721
|
*/
|
711
722
|
nextToken?: PaginationToken;
|
723
|
+
/**
|
724
|
+
* Maximum number of results to return. Default: 100.
|
725
|
+
*/
|
726
|
+
maxResults?: MaxCompositionResults;
|
712
727
|
}
|
713
728
|
export interface ListCompositionsResponse {
|
714
729
|
/**
|
@@ -721,14 +736,14 @@ declare namespace IVSRealTime {
|
|
721
736
|
nextToken?: PaginationToken;
|
722
737
|
}
|
723
738
|
export interface ListEncoderConfigurationsRequest {
|
724
|
-
/**
|
725
|
-
* Maximum number of results to return. Default: 100.
|
726
|
-
*/
|
727
|
-
maxResults?: MaxEncoderConfigurationResults;
|
728
739
|
/**
|
729
740
|
* The first encoder configuration to retrieve. This is used for pagination; see the nextToken response field.
|
730
741
|
*/
|
731
742
|
nextToken?: PaginationToken;
|
743
|
+
/**
|
744
|
+
* Maximum number of results to return. Default: 100.
|
745
|
+
*/
|
746
|
+
maxResults?: MaxEncoderConfigurationResults;
|
732
747
|
}
|
733
748
|
export interface ListEncoderConfigurationsResponse {
|
734
749
|
/**
|
@@ -742,25 +757,25 @@ declare namespace IVSRealTime {
|
|
742
757
|
}
|
743
758
|
export interface ListParticipantEventsRequest {
|
744
759
|
/**
|
745
|
-
*
|
760
|
+
* Stage ARN.
|
746
761
|
*/
|
747
|
-
|
762
|
+
stageArn: StageArn;
|
748
763
|
/**
|
749
|
-
*
|
764
|
+
* ID of a session within the stage.
|
750
765
|
*/
|
751
|
-
|
766
|
+
sessionId: StageSessionId;
|
752
767
|
/**
|
753
768
|
* Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.
|
754
769
|
*/
|
755
770
|
participantId: ParticipantId;
|
756
771
|
/**
|
757
|
-
*
|
772
|
+
* The first participant event to retrieve. This is used for pagination; see the nextToken response field.
|
758
773
|
*/
|
759
|
-
|
774
|
+
nextToken?: PaginationToken;
|
760
775
|
/**
|
761
|
-
*
|
776
|
+
* Maximum number of results to return. Default: 50.
|
762
777
|
*/
|
763
|
-
|
778
|
+
maxResults?: MaxParticipantEventResults;
|
764
779
|
}
|
765
780
|
export interface ListParticipantEventsResponse {
|
766
781
|
/**
|
@@ -774,107 +789,111 @@ declare namespace IVSRealTime {
|
|
774
789
|
}
|
775
790
|
export interface ListParticipantsRequest {
|
776
791
|
/**
|
777
|
-
*
|
792
|
+
* Stage ARN.
|
778
793
|
*/
|
779
|
-
|
794
|
+
stageArn: StageArn;
|
780
795
|
/**
|
781
|
-
*
|
796
|
+
* ID of the session within the stage.
|
782
797
|
*/
|
783
|
-
|
798
|
+
sessionId: StageSessionId;
|
784
799
|
/**
|
785
|
-
* Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, or
|
800
|
+
* Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.
|
786
801
|
*/
|
787
802
|
filterByUserId?: UserId;
|
788
803
|
/**
|
789
|
-
*
|
804
|
+
* Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
|
790
805
|
*/
|
791
|
-
|
806
|
+
filterByPublished?: Published;
|
807
|
+
/**
|
808
|
+
* Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
|
809
|
+
*/
|
810
|
+
filterByState?: ParticipantState;
|
792
811
|
/**
|
793
812
|
* The first participant to retrieve. This is used for pagination; see the nextToken response field.
|
794
813
|
*/
|
795
814
|
nextToken?: PaginationToken;
|
796
815
|
/**
|
797
|
-
*
|
816
|
+
* Maximum number of results to return. Default: 50.
|
798
817
|
*/
|
799
|
-
|
818
|
+
maxResults?: MaxParticipantResults;
|
800
819
|
/**
|
801
|
-
*
|
820
|
+
* Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
|
802
821
|
*/
|
803
|
-
|
822
|
+
filterByRecordingState?: ParticipantRecordingFilterByRecordingState;
|
804
823
|
}
|
805
824
|
export interface ListParticipantsResponse {
|
806
|
-
/**
|
807
|
-
* If there are more participants than maxResults, use nextToken in the request to get the next set.
|
808
|
-
*/
|
809
|
-
nextToken?: PaginationToken;
|
810
825
|
/**
|
811
826
|
* List of the matching participants (summary information only).
|
812
827
|
*/
|
813
828
|
participants: ParticipantList;
|
829
|
+
/**
|
830
|
+
* If there are more participants than maxResults, use nextToken in the request to get the next set.
|
831
|
+
*/
|
832
|
+
nextToken?: PaginationToken;
|
814
833
|
}
|
815
834
|
export interface ListStageSessionsRequest {
|
816
835
|
/**
|
817
|
-
*
|
836
|
+
* Stage ARN.
|
818
837
|
*/
|
819
|
-
|
838
|
+
stageArn: StageArn;
|
820
839
|
/**
|
821
840
|
* The first stage session to retrieve. This is used for pagination; see the nextToken response field.
|
822
841
|
*/
|
823
842
|
nextToken?: PaginationToken;
|
824
843
|
/**
|
825
|
-
*
|
844
|
+
* Maximum number of results to return. Default: 50.
|
826
845
|
*/
|
827
|
-
|
846
|
+
maxResults?: MaxStageSessionResults;
|
828
847
|
}
|
829
848
|
export interface ListStageSessionsResponse {
|
830
|
-
/**
|
831
|
-
* If there are more stage sessions than maxResults, use nextToken in the request to get the next set.
|
832
|
-
*/
|
833
|
-
nextToken?: PaginationToken;
|
834
849
|
/**
|
835
850
|
* List of matching stage sessions.
|
836
851
|
*/
|
837
852
|
stageSessions: StageSessionList;
|
838
|
-
}
|
839
|
-
export interface ListStagesRequest {
|
840
853
|
/**
|
841
|
-
*
|
854
|
+
* If there are more stage sessions than maxResults, use nextToken in the request to get the next set.
|
842
855
|
*/
|
843
|
-
|
856
|
+
nextToken?: PaginationToken;
|
857
|
+
}
|
858
|
+
export interface ListStagesRequest {
|
844
859
|
/**
|
845
860
|
* The first stage to retrieve. This is used for pagination; see the nextToken response field.
|
846
861
|
*/
|
847
862
|
nextToken?: PaginationToken;
|
848
|
-
}
|
849
|
-
export interface ListStagesResponse {
|
850
863
|
/**
|
851
|
-
*
|
864
|
+
* Maximum number of results to return. Default: 50.
|
852
865
|
*/
|
853
|
-
|
866
|
+
maxResults?: MaxStageResults;
|
867
|
+
}
|
868
|
+
export interface ListStagesResponse {
|
854
869
|
/**
|
855
870
|
* List of the matching stages (summary information only).
|
856
871
|
*/
|
857
872
|
stages: StageSummaryList;
|
858
|
-
}
|
859
|
-
export interface ListStorageConfigurationsRequest {
|
860
873
|
/**
|
861
|
-
*
|
874
|
+
* If there are more stages than maxResults, use nextToken in the request to get the next set.
|
862
875
|
*/
|
863
|
-
|
876
|
+
nextToken?: PaginationToken;
|
877
|
+
}
|
878
|
+
export interface ListStorageConfigurationsRequest {
|
864
879
|
/**
|
865
880
|
* The first storage configuration to retrieve. This is used for pagination; see the nextToken response field.
|
866
881
|
*/
|
867
882
|
nextToken?: PaginationToken;
|
868
|
-
}
|
869
|
-
export interface ListStorageConfigurationsResponse {
|
870
883
|
/**
|
871
|
-
*
|
884
|
+
* Maximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.
|
872
885
|
*/
|
873
|
-
|
886
|
+
maxResults?: MaxStorageConfigurationResults;
|
887
|
+
}
|
888
|
+
export interface ListStorageConfigurationsResponse {
|
874
889
|
/**
|
875
890
|
* List of the matching storage configurations.
|
876
891
|
*/
|
877
892
|
storageConfigurations: StorageConfigurationSummaryList;
|
893
|
+
/**
|
894
|
+
* If there are more storage configurations than maxResults, use nextToken in the request to get the next set.
|
895
|
+
*/
|
896
|
+
nextToken?: PaginationToken;
|
878
897
|
}
|
879
898
|
export interface ListTagsForResourceRequest {
|
880
899
|
/**
|
@@ -899,21 +918,29 @@ declare namespace IVSRealTime {
|
|
899
918
|
export type PaginationToken = string;
|
900
919
|
export interface Participant {
|
901
920
|
/**
|
902
|
-
*
|
921
|
+
* Unique identifier for this participant, assigned by IVS.
|
903
922
|
*/
|
904
|
-
|
923
|
+
participantId?: ParticipantId;
|
905
924
|
/**
|
906
|
-
*
|
925
|
+
* Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
907
926
|
*/
|
908
|
-
|
927
|
+
userId?: UserId;
|
909
928
|
/**
|
910
|
-
*
|
929
|
+
* Whether the participant is connected to or disconnected from the stage.
|
911
930
|
*/
|
912
|
-
|
931
|
+
state?: ParticipantState;
|
913
932
|
/**
|
914
933
|
* ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
|
915
934
|
*/
|
916
935
|
firstJoinTime?: Time;
|
936
|
+
/**
|
937
|
+
* Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
938
|
+
*/
|
939
|
+
attributes?: ParticipantAttributes;
|
940
|
+
/**
|
941
|
+
* Whether the participant ever published to the stage session.
|
942
|
+
*/
|
943
|
+
published?: Published;
|
917
944
|
/**
|
918
945
|
* The participant’s Internet Service Provider.
|
919
946
|
*/
|
@@ -927,70 +954,68 @@ declare namespace IVSRealTime {
|
|
927
954
|
*/
|
928
955
|
osVersion?: ParticipantClientAttribute;
|
929
956
|
/**
|
930
|
-
*
|
957
|
+
* The participant’s browser.
|
931
958
|
*/
|
932
|
-
|
959
|
+
browserName?: ParticipantClientAttribute;
|
933
960
|
/**
|
934
|
-
*
|
961
|
+
* The participant’s browser version.
|
935
962
|
*/
|
936
|
-
|
963
|
+
browserVersion?: ParticipantClientAttribute;
|
937
964
|
/**
|
938
965
|
* The participant’s SDK version.
|
939
966
|
*/
|
940
967
|
sdkVersion?: ParticipantClientAttribute;
|
941
968
|
/**
|
942
|
-
*
|
969
|
+
* Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.
|
943
970
|
*/
|
944
|
-
|
971
|
+
recordingS3BucketName?: ParticipantRecordingS3BucketName;
|
945
972
|
/**
|
946
|
-
*
|
973
|
+
* S3 prefix of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.
|
947
974
|
*/
|
948
|
-
|
975
|
+
recordingS3Prefix?: ParticipantRecordingS3Prefix;
|
976
|
+
/**
|
977
|
+
* Participant’s recording state.
|
978
|
+
*/
|
979
|
+
recordingState?: ParticipantRecordingState;
|
949
980
|
}
|
950
981
|
export type ParticipantAttributes = {[key: string]: String};
|
951
982
|
export type ParticipantClientAttribute = string;
|
952
983
|
export type ParticipantId = string;
|
953
984
|
export type ParticipantList = ParticipantSummary[];
|
985
|
+
export type ParticipantRecordingFilterByRecordingState = "STARTING"|"ACTIVE"|"STOPPING"|"STOPPED"|"FAILED"|string;
|
986
|
+
export type ParticipantRecordingMediaType = "AUDIO_VIDEO"|"AUDIO_ONLY"|string;
|
987
|
+
export type ParticipantRecordingMediaTypeList = ParticipantRecordingMediaType[];
|
988
|
+
export type ParticipantRecordingS3BucketName = string;
|
989
|
+
export type ParticipantRecordingS3Prefix = string;
|
990
|
+
export type ParticipantRecordingState = "STARTING"|"ACTIVE"|"STOPPING"|"STOPPED"|"FAILED"|"DISABLED"|string;
|
954
991
|
export type ParticipantState = "CONNECTED"|"DISCONNECTED"|string;
|
955
992
|
export interface ParticipantSummary {
|
956
|
-
/**
|
957
|
-
* ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
|
958
|
-
*/
|
959
|
-
firstJoinTime?: Time;
|
960
993
|
/**
|
961
994
|
* Unique identifier for this participant, assigned by IVS.
|
962
995
|
*/
|
963
996
|
participantId?: ParticipantId;
|
964
|
-
/**
|
965
|
-
* Whether the participant ever published to the stage session.
|
966
|
-
*/
|
967
|
-
published?: Published;
|
968
|
-
/**
|
969
|
-
* Whether the participant is connected to or disconnected from the stage.
|
970
|
-
*/
|
971
|
-
state?: ParticipantState;
|
972
997
|
/**
|
973
998
|
* Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
974
999
|
*/
|
975
1000
|
userId?: UserId;
|
976
|
-
}
|
977
|
-
export interface ParticipantToken {
|
978
1001
|
/**
|
979
|
-
*
|
1002
|
+
* Whether the participant is connected to or disconnected from the stage.
|
980
1003
|
*/
|
981
|
-
|
1004
|
+
state?: ParticipantState;
|
982
1005
|
/**
|
983
|
-
*
|
1006
|
+
* ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
|
984
1007
|
*/
|
985
|
-
|
1008
|
+
firstJoinTime?: Time;
|
986
1009
|
/**
|
987
|
-
*
|
1010
|
+
* Whether the participant ever published to the stage session.
|
988
1011
|
*/
|
989
|
-
|
1012
|
+
published?: Published;
|
990
1013
|
/**
|
991
|
-
*
|
1014
|
+
* Participant’s recording state.
|
992
1015
|
*/
|
993
|
-
|
1016
|
+
recordingState?: ParticipantRecordingState;
|
1017
|
+
}
|
1018
|
+
export interface ParticipantToken {
|
994
1019
|
/**
|
995
1020
|
* Unique identifier for this participant token, assigned by IVS.
|
996
1021
|
*/
|
@@ -1003,19 +1028,27 @@ declare namespace IVSRealTime {
|
|
1003
1028
|
* Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
1004
1029
|
*/
|
1005
1030
|
userId?: ParticipantTokenUserId;
|
1006
|
-
}
|
1007
|
-
export type ParticipantTokenAttributes = {[key: string]: String};
|
1008
|
-
export type ParticipantTokenCapabilities = ParticipantTokenCapability[];
|
1009
|
-
export type ParticipantTokenCapability = "PUBLISH"|"SUBSCRIBE"|string;
|
1010
|
-
export interface ParticipantTokenConfiguration {
|
1011
1031
|
/**
|
1012
|
-
* Application-provided attributes to encode into the
|
1032
|
+
* Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
1013
1033
|
*/
|
1014
1034
|
attributes?: ParticipantTokenAttributes;
|
1035
|
+
/**
|
1036
|
+
* Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
|
1037
|
+
*/
|
1038
|
+
duration?: ParticipantTokenDurationMinutes;
|
1015
1039
|
/**
|
1016
1040
|
* Set of capabilities that the user is allowed to perform in the stage.
|
1017
1041
|
*/
|
1018
1042
|
capabilities?: ParticipantTokenCapabilities;
|
1043
|
+
/**
|
1044
|
+
* ISO 8601 timestamp (returned as a string) for when this token expires.
|
1045
|
+
*/
|
1046
|
+
expirationTime?: ParticipantTokenExpirationTime;
|
1047
|
+
}
|
1048
|
+
export type ParticipantTokenAttributes = {[key: string]: String};
|
1049
|
+
export type ParticipantTokenCapabilities = ParticipantTokenCapability[];
|
1050
|
+
export type ParticipantTokenCapability = "PUBLISH"|"SUBSCRIBE"|string;
|
1051
|
+
export interface ParticipantTokenConfiguration {
|
1019
1052
|
/**
|
1020
1053
|
* Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).
|
1021
1054
|
*/
|
@@ -1024,6 +1057,14 @@ declare namespace IVSRealTime {
|
|
1024
1057
|
* Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
1025
1058
|
*/
|
1026
1059
|
userId?: ParticipantTokenUserId;
|
1060
|
+
/**
|
1061
|
+
* Application-provided attributes to encode into the corresponding participant token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
|
1062
|
+
*/
|
1063
|
+
attributes?: ParticipantTokenAttributes;
|
1064
|
+
/**
|
1065
|
+
* Set of capabilities that the user is allowed to perform in the stage.
|
1066
|
+
*/
|
1067
|
+
capabilities?: ParticipantTokenCapabilities;
|
1027
1068
|
}
|
1028
1069
|
export type ParticipantTokenConfigurations = ParticipantTokenConfiguration[];
|
1029
1070
|
export type ParticipantTokenDurationMinutes = number;
|
@@ -1038,30 +1079,30 @@ declare namespace IVSRealTime {
|
|
1038
1079
|
* This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.
|
1039
1080
|
*/
|
1040
1081
|
featuredParticipantAttribute?: AttributeKey;
|
1082
|
+
/**
|
1083
|
+
* Determines whether to omit participants with stopped video in the composition. Default: false.
|
1084
|
+
*/
|
1085
|
+
omitStoppedVideo?: OmitStoppedVideo;
|
1086
|
+
/**
|
1087
|
+
* Defines how video fits within the participant tile. Default: COVER.
|
1088
|
+
*/
|
1089
|
+
videoFillMode?: VideoFillMode;
|
1041
1090
|
/**
|
1042
1091
|
* Specifies the spacing between participant tiles in pixels. Default: 0.
|
1043
1092
|
*/
|
1044
1093
|
gridGap?: GridGap;
|
1045
1094
|
/**
|
1046
|
-
*
|
1095
|
+
* Identifies the PiP slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot.
|
1047
1096
|
*/
|
1048
|
-
|
1097
|
+
pipParticipantAttribute?: AttributeKey;
|
1049
1098
|
/**
|
1050
1099
|
* Defines PiP behavior when all participants have left. Default: STATIC.
|
1051
1100
|
*/
|
1052
1101
|
pipBehavior?: PipBehavior;
|
1053
|
-
/**
|
1054
|
-
* Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
|
1055
|
-
*/
|
1056
|
-
pipHeight?: PipHeight;
|
1057
1102
|
/**
|
1058
1103
|
* Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.
|
1059
1104
|
*/
|
1060
1105
|
pipOffset?: PipOffset;
|
1061
|
-
/**
|
1062
|
-
* Identifies the PiP slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot.
|
1063
|
-
*/
|
1064
|
-
pipParticipantAttribute?: AttributeKey;
|
1065
1106
|
/**
|
1066
1107
|
* Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
|
1067
1108
|
*/
|
@@ -1071,9 +1112,9 @@ declare namespace IVSRealTime {
|
|
1071
1112
|
*/
|
1072
1113
|
pipWidth?: PipWidth;
|
1073
1114
|
/**
|
1074
|
-
*
|
1115
|
+
* Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
|
1075
1116
|
*/
|
1076
|
-
|
1117
|
+
pipHeight?: PipHeight;
|
1077
1118
|
}
|
1078
1119
|
export type PipHeight = number;
|
1079
1120
|
export type PipOffset = number;
|
@@ -1090,6 +1131,10 @@ declare namespace IVSRealTime {
|
|
1090
1131
|
export type ResourceArn = string;
|
1091
1132
|
export type S3BucketName = string;
|
1092
1133
|
export interface S3DestinationConfiguration {
|
1134
|
+
/**
|
1135
|
+
* ARN of the StorageConfiguration where recorded videos will be stored.
|
1136
|
+
*/
|
1137
|
+
storageConfigurationArn: StorageConfigurationArn;
|
1093
1138
|
/**
|
1094
1139
|
* ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
|
1095
1140
|
*/
|
@@ -1098,10 +1143,6 @@ declare namespace IVSRealTime {
|
|
1098
1143
|
* Array of maps, each of the form string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.
|
1099
1144
|
*/
|
1100
1145
|
recordingConfiguration?: RecordingConfiguration;
|
1101
|
-
/**
|
1102
|
-
* ARN of the StorageConfiguration where recorded videos will be stored.
|
1103
|
-
*/
|
1104
|
-
storageConfigurationArn: StorageConfigurationArn;
|
1105
1146
|
}
|
1106
1147
|
export interface S3Detail {
|
1107
1148
|
/**
|
@@ -1116,10 +1157,6 @@ declare namespace IVSRealTime {
|
|
1116
1157
|
bucketName: S3BucketName;
|
1117
1158
|
}
|
1118
1159
|
export interface Stage {
|
1119
|
-
/**
|
1120
|
-
* ID of the active session within the stage.
|
1121
|
-
*/
|
1122
|
-
activeSessionId?: StageSessionId;
|
1123
1160
|
/**
|
1124
1161
|
* Stage ARN.
|
1125
1162
|
*/
|
@@ -1128,18 +1165,22 @@ declare namespace IVSRealTime {
|
|
1128
1165
|
* Stage name.
|
1129
1166
|
*/
|
1130
1167
|
name?: StageName;
|
1168
|
+
/**
|
1169
|
+
* ID of the active session within the stage.
|
1170
|
+
*/
|
1171
|
+
activeSessionId?: StageSessionId;
|
1131
1172
|
/**
|
1132
1173
|
* Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
|
1133
1174
|
*/
|
1134
1175
|
tags?: Tags;
|
1176
|
+
/**
|
1177
|
+
* Auto-participant-recording configuration object attached to the stage.
|
1178
|
+
*/
|
1179
|
+
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
|
1135
1180
|
}
|
1136
1181
|
export type StageArn = string;
|
1137
1182
|
export type StageName = string;
|
1138
1183
|
export interface StageSession {
|
1139
|
-
/**
|
1140
|
-
* ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
|
1141
|
-
*/
|
1142
|
-
endTime?: Time;
|
1143
1184
|
/**
|
1144
1185
|
* ID of the session within the stage.
|
1145
1186
|
*/
|
@@ -1148,14 +1189,14 @@ declare namespace IVSRealTime {
|
|
1148
1189
|
* ISO 8601 timestamp (returned as a string) when this stage session began.
|
1149
1190
|
*/
|
1150
1191
|
startTime?: Time;
|
1151
|
-
}
|
1152
|
-
export type StageSessionId = string;
|
1153
|
-
export type StageSessionList = StageSessionSummary[];
|
1154
|
-
export interface StageSessionSummary {
|
1155
1192
|
/**
|
1156
1193
|
* ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
|
1157
1194
|
*/
|
1158
1195
|
endTime?: Time;
|
1196
|
+
}
|
1197
|
+
export type StageSessionId = string;
|
1198
|
+
export type StageSessionList = StageSessionSummary[];
|
1199
|
+
export interface StageSessionSummary {
|
1159
1200
|
/**
|
1160
1201
|
* ID of the session within the stage.
|
1161
1202
|
*/
|
@@ -1164,12 +1205,12 @@ declare namespace IVSRealTime {
|
|
1164
1205
|
* ISO 8601 timestamp (returned as a string) when this stage session began.
|
1165
1206
|
*/
|
1166
1207
|
startTime?: Time;
|
1167
|
-
}
|
1168
|
-
export interface StageSummary {
|
1169
1208
|
/**
|
1170
|
-
*
|
1209
|
+
* ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
|
1171
1210
|
*/
|
1172
|
-
|
1211
|
+
endTime?: Time;
|
1212
|
+
}
|
1213
|
+
export interface StageSummary {
|
1173
1214
|
/**
|
1174
1215
|
* Stage ARN.
|
1175
1216
|
*/
|
@@ -1178,6 +1219,10 @@ declare namespace IVSRealTime {
|
|
1178
1219
|
* Stage name.
|
1179
1220
|
*/
|
1180
1221
|
name?: StageName;
|
1222
|
+
/**
|
1223
|
+
* ID of the active session within the stage.
|
1224
|
+
*/
|
1225
|
+
activeSessionId?: StageSessionId;
|
1181
1226
|
/**
|
1182
1227
|
* Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
|
1183
1228
|
*/
|
@@ -1186,9 +1231,9 @@ declare namespace IVSRealTime {
|
|
1186
1231
|
export type StageSummaryList = StageSummary[];
|
1187
1232
|
export interface StartCompositionRequest {
|
1188
1233
|
/**
|
1189
|
-
*
|
1234
|
+
* ARN of the stage to be used for compositing.
|
1190
1235
|
*/
|
1191
|
-
|
1236
|
+
stageArn: StageArn;
|
1192
1237
|
/**
|
1193
1238
|
* Idempotency token.
|
1194
1239
|
*/
|
@@ -1198,9 +1243,9 @@ declare namespace IVSRealTime {
|
|
1198
1243
|
*/
|
1199
1244
|
layout?: LayoutConfiguration;
|
1200
1245
|
/**
|
1201
|
-
*
|
1246
|
+
* Array of destination configuration.
|
1202
1247
|
*/
|
1203
|
-
|
1248
|
+
destinations: DestinationConfigurationList;
|
1204
1249
|
/**
|
1205
1250
|
* Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
|
1206
1251
|
*/
|
@@ -1298,6 +1343,10 @@ declare namespace IVSRealTime {
|
|
1298
1343
|
* Name of the stage to be updated.
|
1299
1344
|
*/
|
1300
1345
|
name?: StageName;
|
1346
|
+
/**
|
1347
|
+
* Auto-participant-recording configuration object to attach to the stage. Auto-participant-recording configuration cannot be updated while recording is active.
|
1348
|
+
*/
|
1349
|
+
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
|
1301
1350
|
}
|
1302
1351
|
export interface UpdateStageResponse {
|
1303
1352
|
/**
|
@@ -1308,21 +1357,21 @@ declare namespace IVSRealTime {
|
|
1308
1357
|
export type UserId = string;
|
1309
1358
|
export interface Video {
|
1310
1359
|
/**
|
1311
|
-
*
|
1312
|
-
*/
|
1313
|
-
bitrate?: Bitrate;
|
1314
|
-
/**
|
1315
|
-
* Video frame rate, in fps. Default: 30.
|
1360
|
+
* Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
|
1316
1361
|
*/
|
1317
|
-
|
1362
|
+
width?: Width;
|
1318
1363
|
/**
|
1319
1364
|
* Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
|
1320
1365
|
*/
|
1321
1366
|
height?: Height;
|
1322
1367
|
/**
|
1323
|
-
* Video
|
1368
|
+
* Video frame rate, in fps. Default: 30.
|
1324
1369
|
*/
|
1325
|
-
|
1370
|
+
framerate?: Framerate;
|
1371
|
+
/**
|
1372
|
+
* Bitrate for generated output, in bps. Default: 2500000.
|
1373
|
+
*/
|
1374
|
+
bitrate?: Bitrate;
|
1326
1375
|
}
|
1327
1376
|
export type VideoAspectRatio = "AUTO"|"VIDEO"|"SQUARE"|"PORTRAIT"|string;
|
1328
1377
|
export type VideoFillMode = "FILL"|"COVER"|"CONTAIN"|string;
|