@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
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { createPaginator } from "@smithy/core";
|
|
2
|
+
import { ListPublicKeysCommand, } from "../commands/ListPublicKeysCommand";
|
|
3
|
+
import { IVSRealTimeClient } from "../IVSRealTimeClient";
|
|
4
|
+
export const paginateListPublicKeys = createPaginator(IVSRealTimeClient, ListPublicKeysCommand, "nextToken", "nextToken", "maxResults");
|
|
@@ -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";
|
|
@@ -44,6 +44,7 @@ export const se_CreateStageCommand = async (input, context) => {
|
|
|
44
44
|
b.bp("/CreateStage");
|
|
45
45
|
let body;
|
|
46
46
|
body = JSON.stringify(take(input, {
|
|
47
|
+
autoParticipantRecordingConfiguration: (_) => _json(_),
|
|
47
48
|
name: [],
|
|
48
49
|
participantTokenConfigurations: (_) => _json(_),
|
|
49
50
|
tags: (_) => _json(_),
|
|
@@ -79,6 +80,19 @@ export const se_DeleteEncoderConfigurationCommand = async (input, context) => {
|
|
|
79
80
|
b.m("POST").h(headers).b(body);
|
|
80
81
|
return b.build();
|
|
81
82
|
};
|
|
83
|
+
export const se_DeletePublicKeyCommand = async (input, context) => {
|
|
84
|
+
const b = rb(input, context);
|
|
85
|
+
const headers = {
|
|
86
|
+
"content-type": "application/json",
|
|
87
|
+
};
|
|
88
|
+
b.bp("/DeletePublicKey");
|
|
89
|
+
let body;
|
|
90
|
+
body = JSON.stringify(take(input, {
|
|
91
|
+
arn: [],
|
|
92
|
+
}));
|
|
93
|
+
b.m("POST").h(headers).b(body);
|
|
94
|
+
return b.build();
|
|
95
|
+
};
|
|
82
96
|
export const se_DeleteStageCommand = async (input, context) => {
|
|
83
97
|
const b = rb(input, context);
|
|
84
98
|
const headers = {
|
|
@@ -161,6 +175,19 @@ export const se_GetParticipantCommand = async (input, context) => {
|
|
|
161
175
|
b.m("POST").h(headers).b(body);
|
|
162
176
|
return b.build();
|
|
163
177
|
};
|
|
178
|
+
export const se_GetPublicKeyCommand = async (input, context) => {
|
|
179
|
+
const b = rb(input, context);
|
|
180
|
+
const headers = {
|
|
181
|
+
"content-type": "application/json",
|
|
182
|
+
};
|
|
183
|
+
b.bp("/GetPublicKey");
|
|
184
|
+
let body;
|
|
185
|
+
body = JSON.stringify(take(input, {
|
|
186
|
+
arn: [],
|
|
187
|
+
}));
|
|
188
|
+
b.m("POST").h(headers).b(body);
|
|
189
|
+
return b.build();
|
|
190
|
+
};
|
|
164
191
|
export const se_GetStageCommand = async (input, context) => {
|
|
165
192
|
const b = rb(input, context);
|
|
166
193
|
const headers = {
|
|
@@ -201,6 +228,21 @@ export const se_GetStorageConfigurationCommand = async (input, context) => {
|
|
|
201
228
|
b.m("POST").h(headers).b(body);
|
|
202
229
|
return b.build();
|
|
203
230
|
};
|
|
231
|
+
export const se_ImportPublicKeyCommand = async (input, context) => {
|
|
232
|
+
const b = rb(input, context);
|
|
233
|
+
const headers = {
|
|
234
|
+
"content-type": "application/json",
|
|
235
|
+
};
|
|
236
|
+
b.bp("/ImportPublicKey");
|
|
237
|
+
let body;
|
|
238
|
+
body = JSON.stringify(take(input, {
|
|
239
|
+
name: [],
|
|
240
|
+
publicKeyMaterial: [],
|
|
241
|
+
tags: (_) => _json(_),
|
|
242
|
+
}));
|
|
243
|
+
b.m("POST").h(headers).b(body);
|
|
244
|
+
return b.build();
|
|
245
|
+
};
|
|
204
246
|
export const se_ListCompositionsCommand = async (input, context) => {
|
|
205
247
|
const b = rb(input, context);
|
|
206
248
|
const headers = {
|
|
@@ -257,6 +299,7 @@ export const se_ListParticipantsCommand = async (input, context) => {
|
|
|
257
299
|
let body;
|
|
258
300
|
body = JSON.stringify(take(input, {
|
|
259
301
|
filterByPublished: [],
|
|
302
|
+
filterByRecordingState: [],
|
|
260
303
|
filterByState: [],
|
|
261
304
|
filterByUserId: [],
|
|
262
305
|
maxResults: [],
|
|
@@ -267,6 +310,20 @@ export const se_ListParticipantsCommand = async (input, context) => {
|
|
|
267
310
|
b.m("POST").h(headers).b(body);
|
|
268
311
|
return b.build();
|
|
269
312
|
};
|
|
313
|
+
export const se_ListPublicKeysCommand = async (input, context) => {
|
|
314
|
+
const b = rb(input, context);
|
|
315
|
+
const headers = {
|
|
316
|
+
"content-type": "application/json",
|
|
317
|
+
};
|
|
318
|
+
b.bp("/ListPublicKeys");
|
|
319
|
+
let body;
|
|
320
|
+
body = JSON.stringify(take(input, {
|
|
321
|
+
maxResults: [],
|
|
322
|
+
nextToken: [],
|
|
323
|
+
}));
|
|
324
|
+
b.m("POST").h(headers).b(body);
|
|
325
|
+
return b.build();
|
|
326
|
+
};
|
|
270
327
|
export const se_ListStagesCommand = async (input, context) => {
|
|
271
328
|
const b = rb(input, context);
|
|
272
329
|
const headers = {
|
|
@@ -387,6 +444,7 @@ export const se_UpdateStageCommand = async (input, context) => {
|
|
|
387
444
|
let body;
|
|
388
445
|
body = JSON.stringify(take(input, {
|
|
389
446
|
arn: [],
|
|
447
|
+
autoParticipantRecordingConfiguration: (_) => _json(_),
|
|
390
448
|
name: [],
|
|
391
449
|
}));
|
|
392
450
|
b.m("POST").h(headers).b(body);
|
|
@@ -459,6 +517,16 @@ export const de_DeleteEncoderConfigurationCommand = async (output, context) => {
|
|
|
459
517
|
await collectBody(output.body, context);
|
|
460
518
|
return contents;
|
|
461
519
|
};
|
|
520
|
+
export const de_DeletePublicKeyCommand = async (output, context) => {
|
|
521
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
522
|
+
return de_CommandError(output, context);
|
|
523
|
+
}
|
|
524
|
+
const contents = map({
|
|
525
|
+
$metadata: deserializeMetadata(output),
|
|
526
|
+
});
|
|
527
|
+
await collectBody(output.body, context);
|
|
528
|
+
return contents;
|
|
529
|
+
};
|
|
462
530
|
export const de_DeleteStageCommand = async (output, context) => {
|
|
463
531
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
464
532
|
return de_CommandError(output, context);
|
|
@@ -531,6 +599,20 @@ export const de_GetParticipantCommand = async (output, context) => {
|
|
|
531
599
|
Object.assign(contents, doc);
|
|
532
600
|
return contents;
|
|
533
601
|
};
|
|
602
|
+
export const de_GetPublicKeyCommand = async (output, context) => {
|
|
603
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
604
|
+
return de_CommandError(output, context);
|
|
605
|
+
}
|
|
606
|
+
const contents = map({
|
|
607
|
+
$metadata: deserializeMetadata(output),
|
|
608
|
+
});
|
|
609
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
610
|
+
const doc = take(data, {
|
|
611
|
+
publicKey: _json,
|
|
612
|
+
});
|
|
613
|
+
Object.assign(contents, doc);
|
|
614
|
+
return contents;
|
|
615
|
+
};
|
|
534
616
|
export const de_GetStageCommand = async (output, context) => {
|
|
535
617
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
536
618
|
return de_CommandError(output, context);
|
|
@@ -573,6 +655,20 @@ export const de_GetStorageConfigurationCommand = async (output, context) => {
|
|
|
573
655
|
Object.assign(contents, doc);
|
|
574
656
|
return contents;
|
|
575
657
|
};
|
|
658
|
+
export const de_ImportPublicKeyCommand = async (output, context) => {
|
|
659
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
660
|
+
return de_CommandError(output, context);
|
|
661
|
+
}
|
|
662
|
+
const contents = map({
|
|
663
|
+
$metadata: deserializeMetadata(output),
|
|
664
|
+
});
|
|
665
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
666
|
+
const doc = take(data, {
|
|
667
|
+
publicKey: _json,
|
|
668
|
+
});
|
|
669
|
+
Object.assign(contents, doc);
|
|
670
|
+
return contents;
|
|
671
|
+
};
|
|
576
672
|
export const de_ListCompositionsCommand = async (output, context) => {
|
|
577
673
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
578
674
|
return de_CommandError(output, context);
|
|
@@ -633,6 +729,21 @@ export const de_ListParticipantsCommand = async (output, context) => {
|
|
|
633
729
|
Object.assign(contents, doc);
|
|
634
730
|
return contents;
|
|
635
731
|
};
|
|
732
|
+
export const de_ListPublicKeysCommand = async (output, context) => {
|
|
733
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
734
|
+
return de_CommandError(output, context);
|
|
735
|
+
}
|
|
736
|
+
const contents = map({
|
|
737
|
+
$metadata: deserializeMetadata(output),
|
|
738
|
+
});
|
|
739
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
740
|
+
const doc = take(data, {
|
|
741
|
+
nextToken: __expectString,
|
|
742
|
+
publicKeys: _json,
|
|
743
|
+
});
|
|
744
|
+
Object.assign(contents, doc);
|
|
745
|
+
return contents;
|
|
746
|
+
};
|
|
636
747
|
export const de_ListStagesCommand = async (output, context) => {
|
|
637
748
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
638
749
|
return de_CommandError(output, context);
|
|
@@ -988,6 +1099,9 @@ const de_Participant = (output, context) => {
|
|
|
988
1099
|
osVersion: __expectString,
|
|
989
1100
|
participantId: __expectString,
|
|
990
1101
|
published: __expectBoolean,
|
|
1102
|
+
recordingS3BucketName: __expectString,
|
|
1103
|
+
recordingS3Prefix: __expectString,
|
|
1104
|
+
recordingState: __expectString,
|
|
991
1105
|
sdkVersion: __expectString,
|
|
992
1106
|
state: __expectString,
|
|
993
1107
|
userId: __expectString,
|
|
@@ -1006,6 +1120,7 @@ const de_ParticipantSummary = (output, context) => {
|
|
|
1006
1120
|
firstJoinTime: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
|
|
1007
1121
|
participantId: __expectString,
|
|
1008
1122
|
published: __expectBoolean,
|
|
1123
|
+
recordingState: __expectString,
|
|
1009
1124
|
state: __expectString,
|
|
1010
1125
|
userId: __expectString,
|
|
1011
1126
|
});
|
|
@@ -4,19 +4,23 @@ import { CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput
|
|
|
4
4
|
import { CreateStageCommandInput, CreateStageCommandOutput } from "./commands/CreateStageCommand";
|
|
5
5
|
import { CreateStorageConfigurationCommandInput, CreateStorageConfigurationCommandOutput } from "./commands/CreateStorageConfigurationCommand";
|
|
6
6
|
import { DeleteEncoderConfigurationCommandInput, DeleteEncoderConfigurationCommandOutput } from "./commands/DeleteEncoderConfigurationCommand";
|
|
7
|
+
import { DeletePublicKeyCommandInput, DeletePublicKeyCommandOutput } from "./commands/DeletePublicKeyCommand";
|
|
7
8
|
import { DeleteStageCommandInput, DeleteStageCommandOutput } from "./commands/DeleteStageCommand";
|
|
8
9
|
import { DeleteStorageConfigurationCommandInput, DeleteStorageConfigurationCommandOutput } from "./commands/DeleteStorageConfigurationCommand";
|
|
9
10
|
import { DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput } from "./commands/DisconnectParticipantCommand";
|
|
10
11
|
import { GetCompositionCommandInput, GetCompositionCommandOutput } from "./commands/GetCompositionCommand";
|
|
11
12
|
import { GetEncoderConfigurationCommandInput, GetEncoderConfigurationCommandOutput } from "./commands/GetEncoderConfigurationCommand";
|
|
12
13
|
import { GetParticipantCommandInput, GetParticipantCommandOutput } from "./commands/GetParticipantCommand";
|
|
14
|
+
import { GetPublicKeyCommandInput, GetPublicKeyCommandOutput } from "./commands/GetPublicKeyCommand";
|
|
13
15
|
import { GetStageCommandInput, GetStageCommandOutput } from "./commands/GetStageCommand";
|
|
14
16
|
import { GetStageSessionCommandInput, GetStageSessionCommandOutput } from "./commands/GetStageSessionCommand";
|
|
15
17
|
import { GetStorageConfigurationCommandInput, GetStorageConfigurationCommandOutput } from "./commands/GetStorageConfigurationCommand";
|
|
18
|
+
import { ImportPublicKeyCommandInput, ImportPublicKeyCommandOutput } from "./commands/ImportPublicKeyCommand";
|
|
16
19
|
import { ListCompositionsCommandInput, ListCompositionsCommandOutput } from "./commands/ListCompositionsCommand";
|
|
17
20
|
import { ListEncoderConfigurationsCommandInput, ListEncoderConfigurationsCommandOutput } from "./commands/ListEncoderConfigurationsCommand";
|
|
18
21
|
import { ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput } from "./commands/ListParticipantEventsCommand";
|
|
19
22
|
import { ListParticipantsCommandInput, ListParticipantsCommandOutput } from "./commands/ListParticipantsCommand";
|
|
23
|
+
import { ListPublicKeysCommandInput, ListPublicKeysCommandOutput } from "./commands/ListPublicKeysCommand";
|
|
20
24
|
import { ListStagesCommandInput, ListStagesCommandOutput } from "./commands/ListStagesCommand";
|
|
21
25
|
import { ListStageSessionsCommandInput, ListStageSessionsCommandOutput } from "./commands/ListStageSessionsCommand";
|
|
22
26
|
import { ListStorageConfigurationsCommandInput, ListStorageConfigurationsCommandOutput } from "./commands/ListStorageConfigurationsCommand";
|
|
@@ -60,6 +64,12 @@ export interface IVSRealTime {
|
|
|
60
64
|
deleteEncoderConfiguration(args: DeleteEncoderConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEncoderConfigurationCommandOutput>;
|
|
61
65
|
deleteEncoderConfiguration(args: DeleteEncoderConfigurationCommandInput, cb: (err: any, data?: DeleteEncoderConfigurationCommandOutput) => void): void;
|
|
62
66
|
deleteEncoderConfiguration(args: DeleteEncoderConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEncoderConfigurationCommandOutput) => void): void;
|
|
67
|
+
/**
|
|
68
|
+
* @see {@link DeletePublicKeyCommand}
|
|
69
|
+
*/
|
|
70
|
+
deletePublicKey(args: DeletePublicKeyCommandInput, options?: __HttpHandlerOptions): Promise<DeletePublicKeyCommandOutput>;
|
|
71
|
+
deletePublicKey(args: DeletePublicKeyCommandInput, cb: (err: any, data?: DeletePublicKeyCommandOutput) => void): void;
|
|
72
|
+
deletePublicKey(args: DeletePublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePublicKeyCommandOutput) => void): void;
|
|
63
73
|
/**
|
|
64
74
|
* @see {@link DeleteStageCommand}
|
|
65
75
|
*/
|
|
@@ -96,6 +106,12 @@ export interface IVSRealTime {
|
|
|
96
106
|
getParticipant(args: GetParticipantCommandInput, options?: __HttpHandlerOptions): Promise<GetParticipantCommandOutput>;
|
|
97
107
|
getParticipant(args: GetParticipantCommandInput, cb: (err: any, data?: GetParticipantCommandOutput) => void): void;
|
|
98
108
|
getParticipant(args: GetParticipantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetParticipantCommandOutput) => void): void;
|
|
109
|
+
/**
|
|
110
|
+
* @see {@link GetPublicKeyCommand}
|
|
111
|
+
*/
|
|
112
|
+
getPublicKey(args: GetPublicKeyCommandInput, options?: __HttpHandlerOptions): Promise<GetPublicKeyCommandOutput>;
|
|
113
|
+
getPublicKey(args: GetPublicKeyCommandInput, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void;
|
|
114
|
+
getPublicKey(args: GetPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void;
|
|
99
115
|
/**
|
|
100
116
|
* @see {@link GetStageCommand}
|
|
101
117
|
*/
|
|
@@ -114,6 +130,12 @@ export interface IVSRealTime {
|
|
|
114
130
|
getStorageConfiguration(args: GetStorageConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetStorageConfigurationCommandOutput>;
|
|
115
131
|
getStorageConfiguration(args: GetStorageConfigurationCommandInput, cb: (err: any, data?: GetStorageConfigurationCommandOutput) => void): void;
|
|
116
132
|
getStorageConfiguration(args: GetStorageConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStorageConfigurationCommandOutput) => void): void;
|
|
133
|
+
/**
|
|
134
|
+
* @see {@link ImportPublicKeyCommand}
|
|
135
|
+
*/
|
|
136
|
+
importPublicKey(args: ImportPublicKeyCommandInput, options?: __HttpHandlerOptions): Promise<ImportPublicKeyCommandOutput>;
|
|
137
|
+
importPublicKey(args: ImportPublicKeyCommandInput, cb: (err: any, data?: ImportPublicKeyCommandOutput) => void): void;
|
|
138
|
+
importPublicKey(args: ImportPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportPublicKeyCommandOutput) => void): void;
|
|
117
139
|
/**
|
|
118
140
|
* @see {@link ListCompositionsCommand}
|
|
119
141
|
*/
|
|
@@ -140,6 +162,13 @@ export interface IVSRealTime {
|
|
|
140
162
|
listParticipants(args: ListParticipantsCommandInput, options?: __HttpHandlerOptions): Promise<ListParticipantsCommandOutput>;
|
|
141
163
|
listParticipants(args: ListParticipantsCommandInput, cb: (err: any, data?: ListParticipantsCommandOutput) => void): void;
|
|
142
164
|
listParticipants(args: ListParticipantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListParticipantsCommandOutput) => void): void;
|
|
165
|
+
/**
|
|
166
|
+
* @see {@link ListPublicKeysCommand}
|
|
167
|
+
*/
|
|
168
|
+
listPublicKeys(): Promise<ListPublicKeysCommandOutput>;
|
|
169
|
+
listPublicKeys(args: ListPublicKeysCommandInput, options?: __HttpHandlerOptions): Promise<ListPublicKeysCommandOutput>;
|
|
170
|
+
listPublicKeys(args: ListPublicKeysCommandInput, cb: (err: any, data?: ListPublicKeysCommandOutput) => void): void;
|
|
171
|
+
listPublicKeys(args: ListPublicKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPublicKeysCommandOutput) => void): void;
|
|
143
172
|
/**
|
|
144
173
|
* @see {@link ListStagesCommand}
|
|
145
174
|
*/
|
|
@@ -198,48 +227,46 @@ export interface IVSRealTime {
|
|
|
198
227
|
updateStage(args: UpdateStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStageCommandOutput) => void): void;
|
|
199
228
|
}
|
|
200
229
|
/**
|
|
201
|
-
* <p>
|
|
202
|
-
* <b>Introduction</b>
|
|
203
|
-
* </p>
|
|
204
|
-
* <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
|
|
230
|
+
* <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
|
|
205
231
|
* API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
|
|
206
232
|
* including errors.
|
|
207
233
|
* </p>
|
|
208
|
-
* <p>
|
|
234
|
+
* <p>
|
|
235
|
+
* <b>Key Concepts</b>
|
|
236
|
+
* </p>
|
|
209
237
|
* <ul>
|
|
210
238
|
* <li>
|
|
211
|
-
* <p>
|
|
212
|
-
*
|
|
213
|
-
* <li>
|
|
214
|
-
* <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
|
|
215
|
-
* </li>
|
|
216
|
-
* <li>
|
|
217
|
-
* <p>A <i>participant object</i> represents participants (people) in the stage and
|
|
218
|
-
* contains information about them. When a token is created, it includes a participant ID;
|
|
219
|
-
* when a participant uses that token to join a stage, the participant is associated with
|
|
220
|
-
* that participant ID. There is a 1:1 mapping between participant tokens and
|
|
221
|
-
* participants.</p>
|
|
239
|
+
* <p>
|
|
240
|
+
* <b>Stage</b> — A virtual space where participants can exchange video in real time.</p>
|
|
222
241
|
* </li>
|
|
223
242
|
* <li>
|
|
224
|
-
* <p>
|
|
225
|
-
*
|
|
226
|
-
* Composition endpoints support this process.</p>
|
|
243
|
+
* <p>
|
|
244
|
+
* <b>Participant token</b> — A token that authenticates a participant when they join a stage.</p>
|
|
227
245
|
* </li>
|
|
228
246
|
* <li>
|
|
229
|
-
* <p>
|
|
230
|
-
*
|
|
247
|
+
* <p>
|
|
248
|
+
* <b>Participant object</b> — Represents participants (people) in the stage and
|
|
249
|
+
* contains information about them. When a token is created, it includes a participant ID;
|
|
250
|
+
* when a participant uses that token to join a stage, the participant is associated with
|
|
251
|
+
* that participant ID. There is a 1:1 mapping between participant tokens and
|
|
252
|
+
* participants.</p>
|
|
231
253
|
* </li>
|
|
232
254
|
* </ul>
|
|
233
|
-
* <p>
|
|
234
|
-
* <b>Resources</b>
|
|
235
|
-
* </p>
|
|
236
|
-
* <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>):</p>
|
|
255
|
+
* <p>For server-side composition:</p>
|
|
237
256
|
* <ul>
|
|
238
257
|
* <li>
|
|
239
258
|
* <p>
|
|
240
|
-
* <b>
|
|
259
|
+
* <b>Composition process</b> — Composites participants
|
|
260
|
+
* of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
|
|
261
|
+
* Composition endpoints support this process.</p>
|
|
262
|
+
* </li>
|
|
263
|
+
* <li>
|
|
264
|
+
* <p>
|
|
265
|
+
* <b>Composition</b> — Controls the look of the outputs,
|
|
266
|
+
* including how participants are positioned in the video.</p>
|
|
241
267
|
* </li>
|
|
242
268
|
* </ul>
|
|
269
|
+
* <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>.</p>
|
|
243
270
|
* <p>
|
|
244
271
|
* <b>Tagging</b>
|
|
245
272
|
* </p>
|
|
@@ -255,157 +282,6 @@ export interface IVSRealTime {
|
|
|
255
282
|
* <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
|
|
256
283
|
* <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
|
|
257
284
|
* <p>At most 50 tags can be applied to a resource.</p>
|
|
258
|
-
* <p>
|
|
259
|
-
* <b>Stages Endpoints</b>
|
|
260
|
-
* </p>
|
|
261
|
-
* <ul>
|
|
262
|
-
* <li>
|
|
263
|
-
* <p>
|
|
264
|
-
* <a>CreateParticipantToken</a> — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.</p>
|
|
265
|
-
* </li>
|
|
266
|
-
* <li>
|
|
267
|
-
* <p>
|
|
268
|
-
* <a>CreateStage</a> — Creates a new stage (and optionally participant tokens).</p>
|
|
269
|
-
* </li>
|
|
270
|
-
* <li>
|
|
271
|
-
* <p>
|
|
272
|
-
* <a>DeleteStage</a> — Shuts down and deletes the specified stage (disconnecting all participants).</p>
|
|
273
|
-
* </li>
|
|
274
|
-
* <li>
|
|
275
|
-
* <p>
|
|
276
|
-
* <a>DisconnectParticipant</a> — Disconnects a specified participant and revokes the participant permanently from a specified stage.</p>
|
|
277
|
-
* </li>
|
|
278
|
-
* <li>
|
|
279
|
-
* <p>
|
|
280
|
-
* <a>GetParticipant</a> — Gets information about the specified
|
|
281
|
-
* participant token.</p>
|
|
282
|
-
* </li>
|
|
283
|
-
* <li>
|
|
284
|
-
* <p>
|
|
285
|
-
* <a>GetStage</a> — Gets information for the specified stage.</p>
|
|
286
|
-
* </li>
|
|
287
|
-
* <li>
|
|
288
|
-
* <p>
|
|
289
|
-
* <a>GetStageSession</a> — Gets information for the specified stage
|
|
290
|
-
* session.</p>
|
|
291
|
-
* </li>
|
|
292
|
-
* <li>
|
|
293
|
-
* <p>
|
|
294
|
-
* <a>ListParticipantEvents</a> — Lists events for a specified
|
|
295
|
-
* participant that occurred during a specified stage session.</p>
|
|
296
|
-
* </li>
|
|
297
|
-
* <li>
|
|
298
|
-
* <p>
|
|
299
|
-
* <a>ListParticipants</a> — Lists all participants in a specified stage
|
|
300
|
-
* session.</p>
|
|
301
|
-
* </li>
|
|
302
|
-
* <li>
|
|
303
|
-
* <p>
|
|
304
|
-
* <a>ListStages</a> — Gets summary information about all stages in your account, in the AWS region where the API request is processed.</p>
|
|
305
|
-
* </li>
|
|
306
|
-
* <li>
|
|
307
|
-
* <p>
|
|
308
|
-
* <a>ListStageSessions</a> — Gets all sessions for a specified stage.</p>
|
|
309
|
-
* </li>
|
|
310
|
-
* <li>
|
|
311
|
-
* <p>
|
|
312
|
-
* <a>UpdateStage</a> — Updates a stage’s configuration.</p>
|
|
313
|
-
* </li>
|
|
314
|
-
* </ul>
|
|
315
|
-
* <p>
|
|
316
|
-
* <b>Composition Endpoints</b>
|
|
317
|
-
* </p>
|
|
318
|
-
* <ul>
|
|
319
|
-
* <li>
|
|
320
|
-
* <p>
|
|
321
|
-
* <a>GetComposition</a> — Gets information about the specified
|
|
322
|
-
* Composition resource.</p>
|
|
323
|
-
* </li>
|
|
324
|
-
* <li>
|
|
325
|
-
* <p>
|
|
326
|
-
* <a>ListCompositions</a> — Gets summary information about all
|
|
327
|
-
* Compositions in your account, in the AWS region where the API request is processed.</p>
|
|
328
|
-
* </li>
|
|
329
|
-
* <li>
|
|
330
|
-
* <p>
|
|
331
|
-
* <a>StartComposition</a> — Starts a Composition from a stage based on
|
|
332
|
-
* the configuration provided in the request.</p>
|
|
333
|
-
* </li>
|
|
334
|
-
* <li>
|
|
335
|
-
* <p>
|
|
336
|
-
* <a>StopComposition</a> — Stops and deletes a Composition resource.
|
|
337
|
-
* Any broadcast from the Composition resource is stopped.</p>
|
|
338
|
-
* </li>
|
|
339
|
-
* </ul>
|
|
340
|
-
* <p>
|
|
341
|
-
* <b>EncoderConfiguration Endpoints</b>
|
|
342
|
-
* </p>
|
|
343
|
-
* <ul>
|
|
344
|
-
* <li>
|
|
345
|
-
* <p>
|
|
346
|
-
* <a>CreateEncoderConfiguration</a> — Creates an EncoderConfiguration object.</p>
|
|
347
|
-
* </li>
|
|
348
|
-
* <li>
|
|
349
|
-
* <p>
|
|
350
|
-
* <a>DeleteEncoderConfiguration</a> — Deletes an EncoderConfiguration
|
|
351
|
-
* resource. Ensures that no Compositions are using this template; otherwise, returns an
|
|
352
|
-
* error.</p>
|
|
353
|
-
* </li>
|
|
354
|
-
* <li>
|
|
355
|
-
* <p>
|
|
356
|
-
* <a>GetEncoderConfiguration</a> — Gets information about the specified
|
|
357
|
-
* EncoderConfiguration resource.</p>
|
|
358
|
-
* </li>
|
|
359
|
-
* <li>
|
|
360
|
-
* <p>
|
|
361
|
-
* <a>ListEncoderConfigurations</a> — Gets summary information about all
|
|
362
|
-
* EncoderConfigurations in your account, in the AWS region where the API request is
|
|
363
|
-
* processed.</p>
|
|
364
|
-
* </li>
|
|
365
|
-
* </ul>
|
|
366
|
-
* <p>
|
|
367
|
-
* <b>StorageConfiguration Endpoints</b>
|
|
368
|
-
* </p>
|
|
369
|
-
* <ul>
|
|
370
|
-
* <li>
|
|
371
|
-
* <p>
|
|
372
|
-
* <a>CreateStorageConfiguration</a> — Creates a new storage configuration, used to enable
|
|
373
|
-
* recording to Amazon S3.</p>
|
|
374
|
-
* </li>
|
|
375
|
-
* <li>
|
|
376
|
-
* <p>
|
|
377
|
-
* <a>DeleteStorageConfiguration</a> — Deletes the storage configuration for the specified ARN.</p>
|
|
378
|
-
* </li>
|
|
379
|
-
* <li>
|
|
380
|
-
* <p>
|
|
381
|
-
* <a>GetStorageConfiguration</a> — Gets the storage configuration for the specified ARN.</p>
|
|
382
|
-
* </li>
|
|
383
|
-
* <li>
|
|
384
|
-
* <p>
|
|
385
|
-
* <a>ListStorageConfigurations</a> — Gets summary information about all storage configurations in your
|
|
386
|
-
* account, in the AWS region where the API request is processed.</p>
|
|
387
|
-
* </li>
|
|
388
|
-
* </ul>
|
|
389
|
-
* <p>
|
|
390
|
-
* <b>Tags Endpoints</b>
|
|
391
|
-
* </p>
|
|
392
|
-
* <ul>
|
|
393
|
-
* <li>
|
|
394
|
-
* <p>
|
|
395
|
-
* <a>ListTagsForResource</a> — Gets information about AWS tags for the
|
|
396
|
-
* specified ARN.</p>
|
|
397
|
-
* </li>
|
|
398
|
-
* <li>
|
|
399
|
-
* <p>
|
|
400
|
-
* <a>TagResource</a> — Adds or updates tags for the AWS resource with
|
|
401
|
-
* the specified ARN.</p>
|
|
402
|
-
* </li>
|
|
403
|
-
* <li>
|
|
404
|
-
* <p>
|
|
405
|
-
* <a>UntagResource</a> — Removes tags from the resource with the
|
|
406
|
-
* specified ARN.</p>
|
|
407
|
-
* </li>
|
|
408
|
-
* </ul>
|
|
409
285
|
* @public
|
|
410
286
|
*/
|
|
411
287
|
export declare class IVSRealTime extends IVSRealTimeClient implements IVSRealTime {
|