@aws-sdk/client-ivs-realtime 3.600.0 → 3.605.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 +49 -170
- package/dist-cjs/index.js +230 -0
- package/dist-es/IVSRealTime.js +8 -0
- package/dist-es/commands/DeletePublicKeyCommand.js +24 -0
- package/dist-es/commands/GetPublicKeyCommand.js +24 -0
- package/dist-es/commands/ImportPublicKeyCommand.js +24 -0
- package/dist-es/commands/ListPublicKeysCommand.js +24 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +19 -0
- package/dist-es/pagination/ListPublicKeysPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +115 -0
- package/dist-types/IVSRealTime.d.ts +53 -177
- package/dist-types/IVSRealTimeClient.d.ts +30 -179
- package/dist-types/commands/CreateStageCommand.d.ts +16 -0
- package/dist-types/commands/DeletePublicKeyCommand.d.ts +75 -0
- package/dist-types/commands/GetParticipantCommand.d.ts +3 -0
- package/dist-types/commands/GetPublicKeyCommand.d.ts +77 -0
- package/dist-types/commands/GetStageCommand.d.ts +10 -0
- package/dist-types/commands/ImportPublicKeyCommand.d.ts +87 -0
- package/dist-types/commands/ListParticipantsCommand.d.ts +2 -0
- package/dist-types/commands/ListPublicKeysCommand.d.ts +76 -0
- package/dist-types/commands/UpdateStageCommand.d.ts +16 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/index.d.ts +24 -177
- package/dist-types/models/models_0.d.ts +305 -22
- package/dist-types/pagination/ListPublicKeysPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
- package/dist-types/ts3.4/IVSRealTime.d.ts +69 -0
- package/dist-types/ts3.4/IVSRealTimeClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/DeletePublicKeyCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetPublicKeyCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/ImportPublicKeyCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListPublicKeysCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +80 -0
- package/dist-types/ts3.4/pagination/ListPublicKeysPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
- package/package.json +1 -1
|
@@ -327,6 +327,34 @@ export interface CreateParticipantTokenResponse {
|
|
|
327
327
|
*/
|
|
328
328
|
participantToken?: ParticipantToken;
|
|
329
329
|
}
|
|
330
|
+
/**
|
|
331
|
+
* @public
|
|
332
|
+
* @enum
|
|
333
|
+
*/
|
|
334
|
+
export declare const ParticipantRecordingMediaType: {
|
|
335
|
+
readonly AUDIO_ONLY: "AUDIO_ONLY";
|
|
336
|
+
readonly AUDIO_VIDEO: "AUDIO_VIDEO";
|
|
337
|
+
};
|
|
338
|
+
/**
|
|
339
|
+
* @public
|
|
340
|
+
*/
|
|
341
|
+
export type ParticipantRecordingMediaType = (typeof ParticipantRecordingMediaType)[keyof typeof ParticipantRecordingMediaType];
|
|
342
|
+
/**
|
|
343
|
+
* <p>Object specifying a configuration for individual participant recording.</p>
|
|
344
|
+
* @public
|
|
345
|
+
*/
|
|
346
|
+
export interface AutoParticipantRecordingConfiguration {
|
|
347
|
+
/**
|
|
348
|
+
* <p>ARN of the <a>StorageConfiguration</a> resource to use for individual participant recording. Default: <code>""</code> (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a <a>Stage</a> is created or updated.</p>
|
|
349
|
+
* @public
|
|
350
|
+
*/
|
|
351
|
+
storageConfigurationArn: string | undefined;
|
|
352
|
+
/**
|
|
353
|
+
* <p>Types of media to be recorded. Default: <code>AUDIO_VIDEO</code>.</p>
|
|
354
|
+
* @public
|
|
355
|
+
*/
|
|
356
|
+
mediaTypes?: ParticipantRecordingMediaType[];
|
|
357
|
+
}
|
|
330
358
|
/**
|
|
331
359
|
* <p>Object specifying a participant token configuration in a stage.</p>
|
|
332
360
|
* @public
|
|
@@ -386,6 +414,27 @@ export interface CreateStageRequest {
|
|
|
386
414
|
* @public
|
|
387
415
|
*/
|
|
388
416
|
tags?: Record<string, string>;
|
|
417
|
+
/**
|
|
418
|
+
* <p>Configuration object for individual participant recording, to attach to the new stage.</p>
|
|
419
|
+
* @public
|
|
420
|
+
*/
|
|
421
|
+
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
|
|
422
|
+
}
|
|
423
|
+
/**
|
|
424
|
+
* <p>Summary information about various endpoints for a stage.</p>
|
|
425
|
+
* @public
|
|
426
|
+
*/
|
|
427
|
+
export interface StageEndpoints {
|
|
428
|
+
/**
|
|
429
|
+
* <p>Events endpoint.</p>
|
|
430
|
+
* @public
|
|
431
|
+
*/
|
|
432
|
+
events?: string;
|
|
433
|
+
/**
|
|
434
|
+
* <p>WHIP endpoint.</p>
|
|
435
|
+
* @public
|
|
436
|
+
*/
|
|
437
|
+
whip?: string;
|
|
389
438
|
}
|
|
390
439
|
/**
|
|
391
440
|
* <p>Object specifying a stage.</p>
|
|
@@ -416,6 +465,16 @@ export interface Stage {
|
|
|
416
465
|
* @public
|
|
417
466
|
*/
|
|
418
467
|
tags?: Record<string, string>;
|
|
468
|
+
/**
|
|
469
|
+
* <p>Configuration object for individual participant recording, attached to the stage.</p>
|
|
470
|
+
* @public
|
|
471
|
+
*/
|
|
472
|
+
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
|
|
473
|
+
/**
|
|
474
|
+
* <p>Summary information about various endpoints for a stage.</p>
|
|
475
|
+
* @public
|
|
476
|
+
*/
|
|
477
|
+
endpoints?: StageEndpoints;
|
|
419
478
|
}
|
|
420
479
|
/**
|
|
421
480
|
* @public
|
|
@@ -524,6 +583,21 @@ export interface DeleteEncoderConfigurationRequest {
|
|
|
524
583
|
*/
|
|
525
584
|
export interface DeleteEncoderConfigurationResponse {
|
|
526
585
|
}
|
|
586
|
+
/**
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
export interface DeletePublicKeyRequest {
|
|
590
|
+
/**
|
|
591
|
+
* <p>ARN of the public key to be deleted.</p>
|
|
592
|
+
* @public
|
|
593
|
+
*/
|
|
594
|
+
arn: string | undefined;
|
|
595
|
+
}
|
|
596
|
+
/**
|
|
597
|
+
* @public
|
|
598
|
+
*/
|
|
599
|
+
export interface DeletePublicKeyResponse {
|
|
600
|
+
}
|
|
527
601
|
/**
|
|
528
602
|
* @public
|
|
529
603
|
*/
|
|
@@ -790,7 +864,7 @@ export interface GridConfiguration {
|
|
|
790
864
|
/**
|
|
791
865
|
* <p>This attribute name identifies the featured slot. A participant with this attribute set
|
|
792
866
|
* to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured
|
|
793
|
-
* slot.</p>
|
|
867
|
+
* slot. Default: <code>""</code> (no featured participant).</p>
|
|
794
868
|
* @public
|
|
795
869
|
*/
|
|
796
870
|
featuredParticipantAttribute?: string;
|
|
@@ -800,14 +874,15 @@ export interface GridConfiguration {
|
|
|
800
874
|
*/
|
|
801
875
|
omitStoppedVideo?: boolean;
|
|
802
876
|
/**
|
|
803
|
-
* <p>Sets the non-featured participant display mode. Default: <code>VIDEO</code>.</p>
|
|
877
|
+
* <p>Sets the non-featured participant display mode, to control the aspect ratio of video tiles. <code>VIDEO</code> is 16:9, <code>SQUARE</code> is 1:1, and <code>PORTRAIT</code> is 3:4. Default: <code>VIDEO</code>.</p>
|
|
804
878
|
* @public
|
|
805
879
|
*/
|
|
806
880
|
videoAspectRatio?: VideoAspectRatio;
|
|
807
881
|
/**
|
|
808
|
-
* <p>Defines how video fits within the participant tile
|
|
809
|
-
*
|
|
810
|
-
*
|
|
882
|
+
* <p>Defines how video content fits within the participant tile: <code>FILL</code> (stretched), <code>COVER</code> (cropped),
|
|
883
|
+
* or <code>CONTAIN</code> (letterboxed). When not set,
|
|
884
|
+
* <code>videoFillMode</code> defaults to <code>COVER</code> fill mode for participants in the grid
|
|
885
|
+
* and to <code>CONTAIN</code> fill mode for featured participants.</p>
|
|
811
886
|
* @public
|
|
812
887
|
*/
|
|
813
888
|
videoFillMode?: VideoFillMode;
|
|
@@ -853,7 +928,7 @@ export interface PipConfiguration {
|
|
|
853
928
|
/**
|
|
854
929
|
* <p>This attribute name identifies the featured slot. A participant with this attribute set
|
|
855
930
|
* to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured
|
|
856
|
-
* slot.</p>
|
|
931
|
+
* slot. Default: <code>""</code> (no featured participant).</p>
|
|
857
932
|
* @public
|
|
858
933
|
*/
|
|
859
934
|
featuredParticipantAttribute?: string;
|
|
@@ -863,8 +938,8 @@ export interface PipConfiguration {
|
|
|
863
938
|
*/
|
|
864
939
|
omitStoppedVideo?: boolean;
|
|
865
940
|
/**
|
|
866
|
-
* <p>Defines how video fits within the participant tile
|
|
867
|
-
* </p>
|
|
941
|
+
* <p>Defines how video content fits within the participant tile: <code>FILL</code> (stretched),
|
|
942
|
+
* <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). Default: <code>COVER</code>.</p>
|
|
868
943
|
* @public
|
|
869
944
|
*/
|
|
870
945
|
videoFillMode?: VideoFillMode;
|
|
@@ -874,14 +949,14 @@ export interface PipConfiguration {
|
|
|
874
949
|
*/
|
|
875
950
|
gridGap?: number;
|
|
876
951
|
/**
|
|
877
|
-
* <p>
|
|
952
|
+
* <p>Specifies the participant for the PiP window. A participant with this attribute set
|
|
878
953
|
* to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a>
|
|
879
|
-
*
|
|
954
|
+
* is placed in the PiP slot. Default: <code>""</code> (no PiP participant).</p>
|
|
880
955
|
* @public
|
|
881
956
|
*/
|
|
882
957
|
pipParticipantAttribute?: string;
|
|
883
958
|
/**
|
|
884
|
-
* <p>Defines PiP behavior when all participants have left. Default: <code>STATIC</code>.</p>
|
|
959
|
+
* <p>Defines PiP behavior when all participants have left: <code>STATIC</code> (maintains original position/size) or <code>DYNAMIC</code> (expands to full composition). Default: <code>STATIC</code>.</p>
|
|
885
960
|
* @public
|
|
886
961
|
*/
|
|
887
962
|
pipBehavior?: PipBehavior;
|
|
@@ -1045,6 +1120,22 @@ export interface GetParticipantRequest {
|
|
|
1045
1120
|
*/
|
|
1046
1121
|
participantId: string | undefined;
|
|
1047
1122
|
}
|
|
1123
|
+
/**
|
|
1124
|
+
* @public
|
|
1125
|
+
* @enum
|
|
1126
|
+
*/
|
|
1127
|
+
export declare const ParticipantRecordingState: {
|
|
1128
|
+
readonly ACTIVE: "ACTIVE";
|
|
1129
|
+
readonly DISABLED: "DISABLED";
|
|
1130
|
+
readonly FAILED: "FAILED";
|
|
1131
|
+
readonly STARTING: "STARTING";
|
|
1132
|
+
readonly STOPPED: "STOPPED";
|
|
1133
|
+
readonly STOPPING: "STOPPING";
|
|
1134
|
+
};
|
|
1135
|
+
/**
|
|
1136
|
+
* @public
|
|
1137
|
+
*/
|
|
1138
|
+
export type ParticipantRecordingState = (typeof ParticipantRecordingState)[keyof typeof ParticipantRecordingState];
|
|
1048
1139
|
/**
|
|
1049
1140
|
* @public
|
|
1050
1141
|
* @enum
|
|
@@ -1129,6 +1220,21 @@ export interface Participant {
|
|
|
1129
1220
|
* @public
|
|
1130
1221
|
*/
|
|
1131
1222
|
sdkVersion?: string;
|
|
1223
|
+
/**
|
|
1224
|
+
* <p>Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled.</p>
|
|
1225
|
+
* @public
|
|
1226
|
+
*/
|
|
1227
|
+
recordingS3BucketName?: string;
|
|
1228
|
+
/**
|
|
1229
|
+
* <p>S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled.</p>
|
|
1230
|
+
* @public
|
|
1231
|
+
*/
|
|
1232
|
+
recordingS3Prefix?: string;
|
|
1233
|
+
/**
|
|
1234
|
+
* <p>The participant’s recording state.</p>
|
|
1235
|
+
* @public
|
|
1236
|
+
*/
|
|
1237
|
+
recordingState?: ParticipantRecordingState;
|
|
1132
1238
|
}
|
|
1133
1239
|
/**
|
|
1134
1240
|
* @public
|
|
@@ -1140,6 +1246,61 @@ export interface GetParticipantResponse {
|
|
|
1140
1246
|
*/
|
|
1141
1247
|
participant?: Participant;
|
|
1142
1248
|
}
|
|
1249
|
+
/**
|
|
1250
|
+
* @public
|
|
1251
|
+
*/
|
|
1252
|
+
export interface GetPublicKeyRequest {
|
|
1253
|
+
/**
|
|
1254
|
+
* <p>ARN of the public key for which the information is to be retrieved.</p>
|
|
1255
|
+
* @public
|
|
1256
|
+
*/
|
|
1257
|
+
arn: string | undefined;
|
|
1258
|
+
}
|
|
1259
|
+
/**
|
|
1260
|
+
* <p>Object specifying a public key used to sign stage participant tokens.</p>
|
|
1261
|
+
* @public
|
|
1262
|
+
*/
|
|
1263
|
+
export interface PublicKey {
|
|
1264
|
+
/**
|
|
1265
|
+
* <p>Public key ARN.</p>
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
arn?: string;
|
|
1269
|
+
/**
|
|
1270
|
+
* <p>Public key name.</p>
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
name?: string;
|
|
1274
|
+
/**
|
|
1275
|
+
* <p>Public key material.</p>
|
|
1276
|
+
* @public
|
|
1277
|
+
*/
|
|
1278
|
+
publicKeyMaterial?: string;
|
|
1279
|
+
/**
|
|
1280
|
+
* <p>The public key fingerprint, a short string used to identify or verify the full public key.</p>
|
|
1281
|
+
* @public
|
|
1282
|
+
*/
|
|
1283
|
+
fingerprint?: string;
|
|
1284
|
+
/**
|
|
1285
|
+
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1286
|
+
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1287
|
+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1288
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1289
|
+
* there.</p>
|
|
1290
|
+
* @public
|
|
1291
|
+
*/
|
|
1292
|
+
tags?: Record<string, string>;
|
|
1293
|
+
}
|
|
1294
|
+
/**
|
|
1295
|
+
* @public
|
|
1296
|
+
*/
|
|
1297
|
+
export interface GetPublicKeyResponse {
|
|
1298
|
+
/**
|
|
1299
|
+
* <p>The public key that is returned.</p>
|
|
1300
|
+
* @public
|
|
1301
|
+
*/
|
|
1302
|
+
publicKey?: PublicKey;
|
|
1303
|
+
}
|
|
1143
1304
|
/**
|
|
1144
1305
|
* @public
|
|
1145
1306
|
*/
|
|
@@ -1230,6 +1391,40 @@ export interface GetStorageConfigurationResponse {
|
|
|
1230
1391
|
*/
|
|
1231
1392
|
storageConfiguration?: StorageConfiguration;
|
|
1232
1393
|
}
|
|
1394
|
+
/**
|
|
1395
|
+
* @public
|
|
1396
|
+
*/
|
|
1397
|
+
export interface ImportPublicKeyRequest {
|
|
1398
|
+
/**
|
|
1399
|
+
* <p>The content of the public key to be imported.</p>
|
|
1400
|
+
* @public
|
|
1401
|
+
*/
|
|
1402
|
+
publicKeyMaterial: string | undefined;
|
|
1403
|
+
/**
|
|
1404
|
+
* <p>Name of the public key to be imported.</p>
|
|
1405
|
+
* @public
|
|
1406
|
+
*/
|
|
1407
|
+
name?: string;
|
|
1408
|
+
/**
|
|
1409
|
+
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1410
|
+
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1411
|
+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1412
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1413
|
+
* there.</p>
|
|
1414
|
+
* @public
|
|
1415
|
+
*/
|
|
1416
|
+
tags?: Record<string, string>;
|
|
1417
|
+
}
|
|
1418
|
+
/**
|
|
1419
|
+
* @public
|
|
1420
|
+
*/
|
|
1421
|
+
export interface ImportPublicKeyResponse {
|
|
1422
|
+
/**
|
|
1423
|
+
* <p>The public key that was imported.</p>
|
|
1424
|
+
* @public
|
|
1425
|
+
*/
|
|
1426
|
+
publicKey?: PublicKey;
|
|
1427
|
+
}
|
|
1233
1428
|
/**
|
|
1234
1429
|
* @public
|
|
1235
1430
|
*/
|
|
@@ -1525,6 +1720,21 @@ export interface ListParticipantEventsResponse {
|
|
|
1525
1720
|
*/
|
|
1526
1721
|
nextToken?: string;
|
|
1527
1722
|
}
|
|
1723
|
+
/**
|
|
1724
|
+
* @public
|
|
1725
|
+
* @enum
|
|
1726
|
+
*/
|
|
1727
|
+
export declare const ParticipantRecordingFilterByRecordingState: {
|
|
1728
|
+
readonly ACTIVE: "ACTIVE";
|
|
1729
|
+
readonly FAILED: "FAILED";
|
|
1730
|
+
readonly STARTING: "STARTING";
|
|
1731
|
+
readonly STOPPED: "STOPPED";
|
|
1732
|
+
readonly STOPPING: "STOPPING";
|
|
1733
|
+
};
|
|
1734
|
+
/**
|
|
1735
|
+
* @public
|
|
1736
|
+
*/
|
|
1737
|
+
export type ParticipantRecordingFilterByRecordingState = (typeof ParticipantRecordingFilterByRecordingState)[keyof typeof ParticipantRecordingFilterByRecordingState];
|
|
1528
1738
|
/**
|
|
1529
1739
|
* @public
|
|
1530
1740
|
*/
|
|
@@ -1540,25 +1750,26 @@ export interface ListParticipantsRequest {
|
|
|
1540
1750
|
*/
|
|
1541
1751
|
sessionId: string | undefined;
|
|
1542
1752
|
/**
|
|
1543
|
-
* <p>Filters the response list to match the specified user ID.
|
|
1544
|
-
* <code>filterByUserId</code>, <code>filterByPublished</code>,
|
|
1545
|
-
* <code>filterByState</code> can be provided per request.
|
|
1546
|
-
*
|
|
1547
|
-
*
|
|
1753
|
+
* <p>Filters the response list to match the specified user ID.
|
|
1754
|
+
* Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
|
|
1755
|
+
* <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.
|
|
1756
|
+
* A <code>userId</code> is a
|
|
1757
|
+
* customer-assigned name to help identify the token; this can be used to link a participant
|
|
1758
|
+
* to a user in the customer’s own systems.</p>
|
|
1548
1759
|
* @public
|
|
1549
1760
|
*/
|
|
1550
1761
|
filterByUserId?: string;
|
|
1551
1762
|
/**
|
|
1552
|
-
* <p>Filters the response list to only show participants who published during the stage
|
|
1553
|
-
*
|
|
1554
|
-
* <code>filterByState</code> can be provided per request.</p>
|
|
1763
|
+
* <p>Filters the response list to only show participants who published during the stage session.
|
|
1764
|
+
* Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
|
|
1765
|
+
* <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
|
|
1555
1766
|
* @public
|
|
1556
1767
|
*/
|
|
1557
1768
|
filterByPublished?: boolean;
|
|
1558
1769
|
/**
|
|
1559
|
-
* <p>Filters the response list to only show participants in the specified state.
|
|
1560
|
-
* <code>filterByUserId</code>, <code>filterByPublished</code>,
|
|
1561
|
-
* <code>filterByState</code> can be provided per request.</p>
|
|
1770
|
+
* <p>Filters the response list to only show participants in the specified state.
|
|
1771
|
+
* Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
|
|
1772
|
+
* <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
|
|
1562
1773
|
* @public
|
|
1563
1774
|
*/
|
|
1564
1775
|
filterByState?: ParticipantState;
|
|
@@ -1573,6 +1784,13 @@ export interface ListParticipantsRequest {
|
|
|
1573
1784
|
* @public
|
|
1574
1785
|
*/
|
|
1575
1786
|
maxResults?: number;
|
|
1787
|
+
/**
|
|
1788
|
+
* <p>Filters the response list to only show participants with the specified recording state.
|
|
1789
|
+
* Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
|
|
1790
|
+
* <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
|
|
1791
|
+
* @public
|
|
1792
|
+
*/
|
|
1793
|
+
filterByRecordingState?: ParticipantRecordingFilterByRecordingState;
|
|
1576
1794
|
}
|
|
1577
1795
|
/**
|
|
1578
1796
|
* <p>Summary object describing a participant that has joined a stage.</p>
|
|
@@ -1608,6 +1826,11 @@ export interface ParticipantSummary {
|
|
|
1608
1826
|
* @public
|
|
1609
1827
|
*/
|
|
1610
1828
|
published?: boolean;
|
|
1829
|
+
/**
|
|
1830
|
+
* <p>The participant’s recording state.</p>
|
|
1831
|
+
* @public
|
|
1832
|
+
*/
|
|
1833
|
+
recordingState?: ParticipantRecordingState;
|
|
1611
1834
|
}
|
|
1612
1835
|
/**
|
|
1613
1836
|
* @public
|
|
@@ -1625,6 +1848,61 @@ export interface ListParticipantsResponse {
|
|
|
1625
1848
|
*/
|
|
1626
1849
|
nextToken?: string;
|
|
1627
1850
|
}
|
|
1851
|
+
/**
|
|
1852
|
+
* @public
|
|
1853
|
+
*/
|
|
1854
|
+
export interface ListPublicKeysRequest {
|
|
1855
|
+
/**
|
|
1856
|
+
* <p>The first public key to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
|
|
1857
|
+
* @public
|
|
1858
|
+
*/
|
|
1859
|
+
nextToken?: string;
|
|
1860
|
+
/**
|
|
1861
|
+
* <p>Maximum number of results to return. Default: 50.</p>
|
|
1862
|
+
* @public
|
|
1863
|
+
*/
|
|
1864
|
+
maxResults?: number;
|
|
1865
|
+
}
|
|
1866
|
+
/**
|
|
1867
|
+
* <p>Summary information about a public key.</p>
|
|
1868
|
+
* @public
|
|
1869
|
+
*/
|
|
1870
|
+
export interface PublicKeySummary {
|
|
1871
|
+
/**
|
|
1872
|
+
* <p>Public key ARN.</p>
|
|
1873
|
+
* @public
|
|
1874
|
+
*/
|
|
1875
|
+
arn?: string;
|
|
1876
|
+
/**
|
|
1877
|
+
* <p>Public key name.</p>
|
|
1878
|
+
* @public
|
|
1879
|
+
*/
|
|
1880
|
+
name?: string;
|
|
1881
|
+
/**
|
|
1882
|
+
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1883
|
+
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1884
|
+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1885
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1886
|
+
* there.</p>
|
|
1887
|
+
* @public
|
|
1888
|
+
*/
|
|
1889
|
+
tags?: Record<string, string>;
|
|
1890
|
+
}
|
|
1891
|
+
/**
|
|
1892
|
+
* @public
|
|
1893
|
+
*/
|
|
1894
|
+
export interface ListPublicKeysResponse {
|
|
1895
|
+
/**
|
|
1896
|
+
* <p>List of the matching public keys (summary information only).</p>
|
|
1897
|
+
* @public
|
|
1898
|
+
*/
|
|
1899
|
+
publicKeys: PublicKeySummary[] | undefined;
|
|
1900
|
+
/**
|
|
1901
|
+
* <p>If there are more public keys than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
|
|
1902
|
+
* @public
|
|
1903
|
+
*/
|
|
1904
|
+
nextToken?: string;
|
|
1905
|
+
}
|
|
1628
1906
|
/**
|
|
1629
1907
|
* @public
|
|
1630
1908
|
*/
|
|
@@ -1951,6 +2229,11 @@ export interface UpdateStageRequest {
|
|
|
1951
2229
|
* @public
|
|
1952
2230
|
*/
|
|
1953
2231
|
name?: string;
|
|
2232
|
+
/**
|
|
2233
|
+
* <p>Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.</p>
|
|
2234
|
+
* @public
|
|
2235
|
+
*/
|
|
2236
|
+
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
|
|
1954
2237
|
}
|
|
1955
2238
|
/**
|
|
1956
2239
|
* @public
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListPublicKeysCommandInput, ListPublicKeysCommandOutput } from "../commands/ListPublicKeysCommand";
|
|
3
|
+
import { IVSRealTimePaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateListPublicKeys: (config: IVSRealTimePaginationConfiguration, input: ListPublicKeysCommandInput, ...rest: any[]) => Paginator<ListPublicKeysCommandOutput>;
|
|
@@ -3,6 +3,7 @@ export * from "./ListCompositionsPaginator";
|
|
|
3
3
|
export * from "./ListEncoderConfigurationsPaginator";
|
|
4
4
|
export * from "./ListParticipantEventsPaginator";
|
|
5
5
|
export * from "./ListParticipantsPaginator";
|
|
6
|
+
export * from "./ListPublicKeysPaginator";
|
|
6
7
|
export * from "./ListStageSessionsPaginator";
|
|
7
8
|
export * from "./ListStagesPaginator";
|
|
8
9
|
export * from "./ListStorageConfigurationsPaginator";
|
|
@@ -5,19 +5,23 @@ import { CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput
|
|
|
5
5
|
import { CreateStageCommandInput, CreateStageCommandOutput } from "../commands/CreateStageCommand";
|
|
6
6
|
import { CreateStorageConfigurationCommandInput, CreateStorageConfigurationCommandOutput } from "../commands/CreateStorageConfigurationCommand";
|
|
7
7
|
import { DeleteEncoderConfigurationCommandInput, DeleteEncoderConfigurationCommandOutput } from "../commands/DeleteEncoderConfigurationCommand";
|
|
8
|
+
import { DeletePublicKeyCommandInput, DeletePublicKeyCommandOutput } from "../commands/DeletePublicKeyCommand";
|
|
8
9
|
import { DeleteStageCommandInput, DeleteStageCommandOutput } from "../commands/DeleteStageCommand";
|
|
9
10
|
import { DeleteStorageConfigurationCommandInput, DeleteStorageConfigurationCommandOutput } from "../commands/DeleteStorageConfigurationCommand";
|
|
10
11
|
import { DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput } from "../commands/DisconnectParticipantCommand";
|
|
11
12
|
import { GetCompositionCommandInput, GetCompositionCommandOutput } from "../commands/GetCompositionCommand";
|
|
12
13
|
import { GetEncoderConfigurationCommandInput, GetEncoderConfigurationCommandOutput } from "../commands/GetEncoderConfigurationCommand";
|
|
13
14
|
import { GetParticipantCommandInput, GetParticipantCommandOutput } from "../commands/GetParticipantCommand";
|
|
15
|
+
import { GetPublicKeyCommandInput, GetPublicKeyCommandOutput } from "../commands/GetPublicKeyCommand";
|
|
14
16
|
import { GetStageCommandInput, GetStageCommandOutput } from "../commands/GetStageCommand";
|
|
15
17
|
import { GetStageSessionCommandInput, GetStageSessionCommandOutput } from "../commands/GetStageSessionCommand";
|
|
16
18
|
import { GetStorageConfigurationCommandInput, GetStorageConfigurationCommandOutput } from "../commands/GetStorageConfigurationCommand";
|
|
19
|
+
import { ImportPublicKeyCommandInput, ImportPublicKeyCommandOutput } from "../commands/ImportPublicKeyCommand";
|
|
17
20
|
import { ListCompositionsCommandInput, ListCompositionsCommandOutput } from "../commands/ListCompositionsCommand";
|
|
18
21
|
import { ListEncoderConfigurationsCommandInput, ListEncoderConfigurationsCommandOutput } from "../commands/ListEncoderConfigurationsCommand";
|
|
19
22
|
import { ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput } from "../commands/ListParticipantEventsCommand";
|
|
20
23
|
import { ListParticipantsCommandInput, ListParticipantsCommandOutput } from "../commands/ListParticipantsCommand";
|
|
24
|
+
import { ListPublicKeysCommandInput, ListPublicKeysCommandOutput } from "../commands/ListPublicKeysCommand";
|
|
21
25
|
import { ListStagesCommandInput, ListStagesCommandOutput } from "../commands/ListStagesCommand";
|
|
22
26
|
import { ListStageSessionsCommandInput, ListStageSessionsCommandOutput } from "../commands/ListStageSessionsCommand";
|
|
23
27
|
import { ListStorageConfigurationsCommandInput, ListStorageConfigurationsCommandOutput } from "../commands/ListStorageConfigurationsCommand";
|
|
@@ -47,6 +51,10 @@ export declare const se_CreateStorageConfigurationCommand: (input: CreateStorage
|
|
|
47
51
|
* serializeAws_restJson1DeleteEncoderConfigurationCommand
|
|
48
52
|
*/
|
|
49
53
|
export declare const se_DeleteEncoderConfigurationCommand: (input: DeleteEncoderConfigurationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
54
|
+
/**
|
|
55
|
+
* serializeAws_restJson1DeletePublicKeyCommand
|
|
56
|
+
*/
|
|
57
|
+
export declare const se_DeletePublicKeyCommand: (input: DeletePublicKeyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
50
58
|
/**
|
|
51
59
|
* serializeAws_restJson1DeleteStageCommand
|
|
52
60
|
*/
|
|
@@ -71,6 +79,10 @@ export declare const se_GetEncoderConfigurationCommand: (input: GetEncoderConfig
|
|
|
71
79
|
* serializeAws_restJson1GetParticipantCommand
|
|
72
80
|
*/
|
|
73
81
|
export declare const se_GetParticipantCommand: (input: GetParticipantCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
82
|
+
/**
|
|
83
|
+
* serializeAws_restJson1GetPublicKeyCommand
|
|
84
|
+
*/
|
|
85
|
+
export declare const se_GetPublicKeyCommand: (input: GetPublicKeyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
74
86
|
/**
|
|
75
87
|
* serializeAws_restJson1GetStageCommand
|
|
76
88
|
*/
|
|
@@ -83,6 +95,10 @@ export declare const se_GetStageSessionCommand: (input: GetStageSessionCommandIn
|
|
|
83
95
|
* serializeAws_restJson1GetStorageConfigurationCommand
|
|
84
96
|
*/
|
|
85
97
|
export declare const se_GetStorageConfigurationCommand: (input: GetStorageConfigurationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
98
|
+
/**
|
|
99
|
+
* serializeAws_restJson1ImportPublicKeyCommand
|
|
100
|
+
*/
|
|
101
|
+
export declare const se_ImportPublicKeyCommand: (input: ImportPublicKeyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
86
102
|
/**
|
|
87
103
|
* serializeAws_restJson1ListCompositionsCommand
|
|
88
104
|
*/
|
|
@@ -99,6 +115,10 @@ export declare const se_ListParticipantEventsCommand: (input: ListParticipantEve
|
|
|
99
115
|
* serializeAws_restJson1ListParticipantsCommand
|
|
100
116
|
*/
|
|
101
117
|
export declare const se_ListParticipantsCommand: (input: ListParticipantsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
118
|
+
/**
|
|
119
|
+
* serializeAws_restJson1ListPublicKeysCommand
|
|
120
|
+
*/
|
|
121
|
+
export declare const se_ListPublicKeysCommand: (input: ListPublicKeysCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
102
122
|
/**
|
|
103
123
|
* serializeAws_restJson1ListStagesCommand
|
|
104
124
|
*/
|
|
@@ -155,6 +175,10 @@ export declare const de_CreateStorageConfigurationCommand: (output: __HttpRespon
|
|
|
155
175
|
* deserializeAws_restJson1DeleteEncoderConfigurationCommand
|
|
156
176
|
*/
|
|
157
177
|
export declare const de_DeleteEncoderConfigurationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteEncoderConfigurationCommandOutput>;
|
|
178
|
+
/**
|
|
179
|
+
* deserializeAws_restJson1DeletePublicKeyCommand
|
|
180
|
+
*/
|
|
181
|
+
export declare const de_DeletePublicKeyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeletePublicKeyCommandOutput>;
|
|
158
182
|
/**
|
|
159
183
|
* deserializeAws_restJson1DeleteStageCommand
|
|
160
184
|
*/
|
|
@@ -179,6 +203,10 @@ export declare const de_GetEncoderConfigurationCommand: (output: __HttpResponse,
|
|
|
179
203
|
* deserializeAws_restJson1GetParticipantCommand
|
|
180
204
|
*/
|
|
181
205
|
export declare const de_GetParticipantCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetParticipantCommandOutput>;
|
|
206
|
+
/**
|
|
207
|
+
* deserializeAws_restJson1GetPublicKeyCommand
|
|
208
|
+
*/
|
|
209
|
+
export declare const de_GetPublicKeyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetPublicKeyCommandOutput>;
|
|
182
210
|
/**
|
|
183
211
|
* deserializeAws_restJson1GetStageCommand
|
|
184
212
|
*/
|
|
@@ -191,6 +219,10 @@ export declare const de_GetStageSessionCommand: (output: __HttpResponse, context
|
|
|
191
219
|
* deserializeAws_restJson1GetStorageConfigurationCommand
|
|
192
220
|
*/
|
|
193
221
|
export declare const de_GetStorageConfigurationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetStorageConfigurationCommandOutput>;
|
|
222
|
+
/**
|
|
223
|
+
* deserializeAws_restJson1ImportPublicKeyCommand
|
|
224
|
+
*/
|
|
225
|
+
export declare const de_ImportPublicKeyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ImportPublicKeyCommandOutput>;
|
|
194
226
|
/**
|
|
195
227
|
* deserializeAws_restJson1ListCompositionsCommand
|
|
196
228
|
*/
|
|
@@ -207,6 +239,10 @@ export declare const de_ListParticipantEventsCommand: (output: __HttpResponse, c
|
|
|
207
239
|
* deserializeAws_restJson1ListParticipantsCommand
|
|
208
240
|
*/
|
|
209
241
|
export declare const de_ListParticipantsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListParticipantsCommandOutput>;
|
|
242
|
+
/**
|
|
243
|
+
* deserializeAws_restJson1ListPublicKeysCommand
|
|
244
|
+
*/
|
|
245
|
+
export declare const de_ListPublicKeysCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListPublicKeysCommandOutput>;
|
|
210
246
|
/**
|
|
211
247
|
* deserializeAws_restJson1ListStagesCommand
|
|
212
248
|
*/
|