@aws-sdk/client-ivs-realtime 3.816.0 → 3.820.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/README.md +47 -0
  2. package/dist-cjs/index.js +190 -1
  3. package/dist-cjs/runtimeConfig.js +4 -1
  4. package/dist-es/IVSRealTime.js +6 -0
  5. package/dist-es/commands/ListParticipantReplicasCommand.js +22 -0
  6. package/dist-es/commands/StartParticipantReplicationCommand.js +22 -0
  7. package/dist-es/commands/StopParticipantReplicationCommand.js +22 -0
  8. package/dist-es/commands/index.js +3 -0
  9. package/dist-es/models/models_0.js +11 -0
  10. package/dist-es/pagination/ListParticipantReplicasPaginator.js +4 -0
  11. package/dist-es/pagination/index.js +1 -0
  12. package/dist-es/protocols/Aws_restJson1.js +108 -0
  13. package/dist-es/runtimeConfig.js +4 -1
  14. package/dist-types/IVSRealTime.d.ts +44 -0
  15. package/dist-types/IVSRealTimeClient.d.ts +28 -2
  16. package/dist-types/commands/CreateStageCommand.d.ts +2 -0
  17. package/dist-types/commands/GetParticipantCommand.d.ts +4 -0
  18. package/dist-types/commands/GetStageCommand.d.ts +1 -0
  19. package/dist-types/commands/ListParticipantEventsCommand.d.ts +3 -0
  20. package/dist-types/commands/ListParticipantReplicasCommand.d.ts +91 -0
  21. package/dist-types/commands/ListParticipantsCommand.d.ts +4 -0
  22. package/dist-types/commands/StartParticipantReplicationCommand.d.ts +105 -0
  23. package/dist-types/commands/StopParticipantReplicationCommand.d.ts +92 -0
  24. package/dist-types/commands/UpdateStageCommand.d.ts +2 -0
  25. package/dist-types/commands/index.d.ts +3 -0
  26. package/dist-types/index.d.ts +23 -0
  27. package/dist-types/models/models_0.d.ts +322 -4
  28. package/dist-types/pagination/ListParticipantReplicasPaginator.d.ts +7 -0
  29. package/dist-types/pagination/index.d.ts +1 -0
  30. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  31. package/dist-types/ts3.4/IVSRealTime.d.ts +51 -0
  32. package/dist-types/ts3.4/IVSRealTimeClient.d.ts +18 -0
  33. package/dist-types/ts3.4/commands/ListParticipantReplicasCommand.d.ts +51 -0
  34. package/dist-types/ts3.4/commands/StartParticipantReplicationCommand.d.ts +51 -0
  35. package/dist-types/ts3.4/commands/StopParticipantReplicationCommand.d.ts +51 -0
  36. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  37. package/dist-types/ts3.4/models/models_0.d.ts +75 -0
  38. package/dist-types/ts3.4/pagination/ListParticipantReplicasPaginator.d.ts +11 -0
  39. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  40. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  41. package/package.json +2 -2
@@ -352,6 +352,22 @@ export const se_ListParticipantEventsCommand = async (input, context) => {
352
352
  b.m("POST").h(headers).b(body);
353
353
  return b.build();
354
354
  };
355
+ export const se_ListParticipantReplicasCommand = async (input, context) => {
356
+ const b = rb(input, context);
357
+ const headers = {
358
+ "content-type": "application/json",
359
+ };
360
+ b.bp("/ListParticipantReplicas");
361
+ let body;
362
+ body = JSON.stringify(take(input, {
363
+ maxResults: [],
364
+ nextToken: [],
365
+ participantId: [],
366
+ sourceStageArn: [],
367
+ }));
368
+ b.m("POST").h(headers).b(body);
369
+ return b.build();
370
+ };
355
371
  export const se_ListParticipantsCommand = async (input, context) => {
356
372
  const b = rb(input, context);
357
373
  const headers = {
@@ -455,6 +471,23 @@ export const se_StartCompositionCommand = async (input, context) => {
455
471
  b.m("POST").h(headers).b(body);
456
472
  return b.build();
457
473
  };
474
+ export const se_StartParticipantReplicationCommand = async (input, context) => {
475
+ const b = rb(input, context);
476
+ const headers = {
477
+ "content-type": "application/json",
478
+ };
479
+ b.bp("/StartParticipantReplication");
480
+ let body;
481
+ body = JSON.stringify(take(input, {
482
+ attributes: (_) => _json(_),
483
+ destinationStageArn: [],
484
+ participantId: [],
485
+ reconnectWindowSeconds: [],
486
+ sourceStageArn: [],
487
+ }));
488
+ b.m("POST").h(headers).b(body);
489
+ return b.build();
490
+ };
458
491
  export const se_StopCompositionCommand = async (input, context) => {
459
492
  const b = rb(input, context);
460
493
  const headers = {
@@ -468,6 +501,21 @@ export const se_StopCompositionCommand = async (input, context) => {
468
501
  b.m("POST").h(headers).b(body);
469
502
  return b.build();
470
503
  };
504
+ export const se_StopParticipantReplicationCommand = async (input, context) => {
505
+ const b = rb(input, context);
506
+ const headers = {
507
+ "content-type": "application/json",
508
+ };
509
+ b.bp("/StopParticipantReplication");
510
+ let body;
511
+ body = JSON.stringify(take(input, {
512
+ destinationStageArn: [],
513
+ participantId: [],
514
+ sourceStageArn: [],
515
+ }));
516
+ b.m("POST").h(headers).b(body);
517
+ return b.build();
518
+ };
471
519
  export const se_TagResourceCommand = async (input, context) => {
472
520
  const b = rb(input, context);
473
521
  const headers = {
@@ -840,6 +888,21 @@ export const de_ListParticipantEventsCommand = async (output, context) => {
840
888
  Object.assign(contents, doc);
841
889
  return contents;
842
890
  };
891
+ export const de_ListParticipantReplicasCommand = async (output, context) => {
892
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
893
+ return de_CommandError(output, context);
894
+ }
895
+ const contents = map({
896
+ $metadata: deserializeMetadata(output),
897
+ });
898
+ const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
899
+ const doc = take(data, {
900
+ nextToken: __expectString,
901
+ replicas: _json,
902
+ });
903
+ Object.assign(contents, doc);
904
+ return contents;
905
+ };
843
906
  export const de_ListParticipantsCommand = async (output, context) => {
844
907
  if (output.statusCode !== 200 && output.statusCode >= 300) {
845
908
  return de_CommandError(output, context);
@@ -943,6 +1006,23 @@ export const de_StartCompositionCommand = async (output, context) => {
943
1006
  Object.assign(contents, doc);
944
1007
  return contents;
945
1008
  };
1009
+ export const de_StartParticipantReplicationCommand = async (output, context) => {
1010
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
1011
+ return de_CommandError(output, context);
1012
+ }
1013
+ const contents = map({
1014
+ $metadata: deserializeMetadata(output),
1015
+ [_aCAO]: [, output.headers[_acao]],
1016
+ [_aCEH]: [, output.headers[_aceh]],
1017
+ [_cC]: [, output.headers[_cc]],
1018
+ [_cSP]: [, output.headers[_csp]],
1019
+ [_sTS]: [, output.headers[_sts]],
1020
+ [_xCTO]: [, output.headers[_xcto]],
1021
+ [_xFO]: [, output.headers[_xfo]],
1022
+ });
1023
+ await collectBody(output.body, context);
1024
+ return contents;
1025
+ };
946
1026
  export const de_StopCompositionCommand = async (output, context) => {
947
1027
  if (output.statusCode !== 200 && output.statusCode >= 300) {
948
1028
  return de_CommandError(output, context);
@@ -953,6 +1033,23 @@ export const de_StopCompositionCommand = async (output, context) => {
953
1033
  await collectBody(output.body, context);
954
1034
  return contents;
955
1035
  };
1036
+ export const de_StopParticipantReplicationCommand = async (output, context) => {
1037
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
1038
+ return de_CommandError(output, context);
1039
+ }
1040
+ const contents = map({
1041
+ $metadata: deserializeMetadata(output),
1042
+ [_aCAO]: [, output.headers[_acao]],
1043
+ [_aCEH]: [, output.headers[_aceh]],
1044
+ [_cC]: [, output.headers[_cc]],
1045
+ [_cSP]: [, output.headers[_csp]],
1046
+ [_sTS]: [, output.headers[_sts]],
1047
+ [_xCTO]: [, output.headers[_xcto]],
1048
+ [_xFO]: [, output.headers[_xfo]],
1049
+ });
1050
+ await collectBody(output.body, context);
1051
+ return contents;
1052
+ };
956
1053
  export const de_TagResourceCommand = async (output, context) => {
957
1054
  if (output.statusCode !== 200 && output.statusCode >= 300) {
958
1055
  return de_CommandError(output, context);
@@ -1276,11 +1373,14 @@ const de_EncoderConfiguration = (output, context) => {
1276
1373
  };
1277
1374
  const de_Event = (output, context) => {
1278
1375
  return take(output, {
1376
+ destinationSessionId: __expectString,
1377
+ destinationStageArn: __expectString,
1279
1378
  errorCode: __expectString,
1280
1379
  eventTime: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
1281
1380
  name: __expectString,
1282
1381
  participantId: __expectString,
1283
1382
  remoteParticipantId: __expectString,
1383
+ replica: __expectBoolean,
1284
1384
  });
1285
1385
  };
1286
1386
  const de_EventList = (output, context) => {
@@ -1306,7 +1406,11 @@ const de_Participant = (output, context) => {
1306
1406
  recordingS3BucketName: __expectString,
1307
1407
  recordingS3Prefix: __expectString,
1308
1408
  recordingState: __expectString,
1409
+ replicationState: __expectString,
1410
+ replicationType: __expectString,
1309
1411
  sdkVersion: __expectString,
1412
+ sourceSessionId: __expectString,
1413
+ sourceStageArn: __expectString,
1310
1414
  state: __expectString,
1311
1415
  userId: __expectString,
1312
1416
  });
@@ -1325,6 +1429,10 @@ const de_ParticipantSummary = (output, context) => {
1325
1429
  participantId: __expectString,
1326
1430
  published: __expectBoolean,
1327
1431
  recordingState: __expectString,
1432
+ replicationState: __expectString,
1433
+ replicationType: __expectString,
1434
+ sourceSessionId: __expectString,
1435
+ sourceStageArn: __expectString,
1328
1436
  state: __expectString,
1329
1437
  userId: __expectString,
1330
1438
  });
@@ -19,7 +19,10 @@ export const getRuntimeConfig = (config) => {
19
19
  const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
20
20
  const clientSharedValues = getSharedRuntimeConfig(config);
21
21
  awsCheckVersion(process.version);
22
- const loaderConfig = { profile: config?.profile, logger: clientSharedValues.logger };
22
+ const loaderConfig = {
23
+ profile: config?.profile,
24
+ logger: clientSharedValues.logger,
25
+ };
23
26
  return {
24
27
  ...clientSharedValues,
25
28
  ...config,
@@ -23,6 +23,7 @@ import { ListCompositionsCommandInput, ListCompositionsCommandOutput } from "./c
23
23
  import { ListEncoderConfigurationsCommandInput, ListEncoderConfigurationsCommandOutput } from "./commands/ListEncoderConfigurationsCommand";
24
24
  import { ListIngestConfigurationsCommandInput, ListIngestConfigurationsCommandOutput } from "./commands/ListIngestConfigurationsCommand";
25
25
  import { ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput } from "./commands/ListParticipantEventsCommand";
26
+ import { ListParticipantReplicasCommandInput, ListParticipantReplicasCommandOutput } from "./commands/ListParticipantReplicasCommand";
26
27
  import { ListParticipantsCommandInput, ListParticipantsCommandOutput } from "./commands/ListParticipantsCommand";
27
28
  import { ListPublicKeysCommandInput, ListPublicKeysCommandOutput } from "./commands/ListPublicKeysCommand";
28
29
  import { ListStagesCommandInput, ListStagesCommandOutput } from "./commands/ListStagesCommand";
@@ -30,7 +31,9 @@ import { ListStageSessionsCommandInput, ListStageSessionsCommandOutput } from ".
30
31
  import { ListStorageConfigurationsCommandInput, ListStorageConfigurationsCommandOutput } from "./commands/ListStorageConfigurationsCommand";
31
32
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
32
33
  import { StartCompositionCommandInput, StartCompositionCommandOutput } from "./commands/StartCompositionCommand";
34
+ import { StartParticipantReplicationCommandInput, StartParticipantReplicationCommandOutput } from "./commands/StartParticipantReplicationCommand";
33
35
  import { StopCompositionCommandInput, StopCompositionCommandOutput } from "./commands/StopCompositionCommand";
36
+ import { StopParticipantReplicationCommandInput, StopParticipantReplicationCommandOutput } from "./commands/StopParticipantReplicationCommand";
34
37
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
35
38
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
36
39
  import { UpdateIngestConfigurationCommandInput, UpdateIngestConfigurationCommandOutput } from "./commands/UpdateIngestConfigurationCommand";
@@ -186,6 +189,12 @@ export interface IVSRealTime {
186
189
  listParticipantEvents(args: ListParticipantEventsCommandInput, options?: __HttpHandlerOptions): Promise<ListParticipantEventsCommandOutput>;
187
190
  listParticipantEvents(args: ListParticipantEventsCommandInput, cb: (err: any, data?: ListParticipantEventsCommandOutput) => void): void;
188
191
  listParticipantEvents(args: ListParticipantEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListParticipantEventsCommandOutput) => void): void;
192
+ /**
193
+ * @see {@link ListParticipantReplicasCommand}
194
+ */
195
+ listParticipantReplicas(args: ListParticipantReplicasCommandInput, options?: __HttpHandlerOptions): Promise<ListParticipantReplicasCommandOutput>;
196
+ listParticipantReplicas(args: ListParticipantReplicasCommandInput, cb: (err: any, data?: ListParticipantReplicasCommandOutput) => void): void;
197
+ listParticipantReplicas(args: ListParticipantReplicasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListParticipantReplicasCommandOutput) => void): void;
189
198
  /**
190
199
  * @see {@link ListParticipantsCommand}
191
200
  */
@@ -231,12 +240,24 @@ export interface IVSRealTime {
231
240
  startComposition(args: StartCompositionCommandInput, options?: __HttpHandlerOptions): Promise<StartCompositionCommandOutput>;
232
241
  startComposition(args: StartCompositionCommandInput, cb: (err: any, data?: StartCompositionCommandOutput) => void): void;
233
242
  startComposition(args: StartCompositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCompositionCommandOutput) => void): void;
243
+ /**
244
+ * @see {@link StartParticipantReplicationCommand}
245
+ */
246
+ startParticipantReplication(args: StartParticipantReplicationCommandInput, options?: __HttpHandlerOptions): Promise<StartParticipantReplicationCommandOutput>;
247
+ startParticipantReplication(args: StartParticipantReplicationCommandInput, cb: (err: any, data?: StartParticipantReplicationCommandOutput) => void): void;
248
+ startParticipantReplication(args: StartParticipantReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartParticipantReplicationCommandOutput) => void): void;
234
249
  /**
235
250
  * @see {@link StopCompositionCommand}
236
251
  */
237
252
  stopComposition(args: StopCompositionCommandInput, options?: __HttpHandlerOptions): Promise<StopCompositionCommandOutput>;
238
253
  stopComposition(args: StopCompositionCommandInput, cb: (err: any, data?: StopCompositionCommandOutput) => void): void;
239
254
  stopComposition(args: StopCompositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCompositionCommandOutput) => void): void;
255
+ /**
256
+ * @see {@link StopParticipantReplicationCommand}
257
+ */
258
+ stopParticipantReplication(args: StopParticipantReplicationCommandInput, options?: __HttpHandlerOptions): Promise<StopParticipantReplicationCommandOutput>;
259
+ stopParticipantReplication(args: StopParticipantReplicationCommandInput, cb: (err: any, data?: StopParticipantReplicationCommandOutput) => void): void;
260
+ stopParticipantReplication(args: StopParticipantReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopParticipantReplicationCommandOutput) => void): void;
240
261
  /**
241
262
  * @see {@link TagResourceCommand}
242
263
  */
@@ -302,6 +323,29 @@ export interface IVSRealTime {
302
323
  * including how participants are positioned in the video.</p>
303
324
  * </li>
304
325
  * </ul>
326
+ * <p>For participant replication:</p>
327
+ * <ul>
328
+ * <li>
329
+ * <p>
330
+ * <b>Source stage</b> — The stage where the participant originally joined, which is used as the source for
331
+ * replication.</p>
332
+ * </li>
333
+ * <li>
334
+ * <p>
335
+ * <b>Destination stage</b> — The stage to which the participant is replicated.
336
+ * </p>
337
+ * </li>
338
+ * <li>
339
+ * <p>
340
+ * <b>Replicated participant</b> — A participant in a stage that is replicated to one or more destination stages.
341
+ * </p>
342
+ * </li>
343
+ * <li>
344
+ * <p>
345
+ * <b>Replica participant</b> — A participant in a destination stage that is replicated from another stage
346
+ * (the source stage).</p>
347
+ * </li>
348
+ * </ul>
305
349
  * <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>
306
350
  * <p>
307
351
  * <b>Tagging</b>
@@ -31,6 +31,7 @@ import { ListCompositionsCommandInput, ListCompositionsCommandOutput } from "./c
31
31
  import { ListEncoderConfigurationsCommandInput, ListEncoderConfigurationsCommandOutput } from "./commands/ListEncoderConfigurationsCommand";
32
32
  import { ListIngestConfigurationsCommandInput, ListIngestConfigurationsCommandOutput } from "./commands/ListIngestConfigurationsCommand";
33
33
  import { ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput } from "./commands/ListParticipantEventsCommand";
34
+ import { ListParticipantReplicasCommandInput, ListParticipantReplicasCommandOutput } from "./commands/ListParticipantReplicasCommand";
34
35
  import { ListParticipantsCommandInput, ListParticipantsCommandOutput } from "./commands/ListParticipantsCommand";
35
36
  import { ListPublicKeysCommandInput, ListPublicKeysCommandOutput } from "./commands/ListPublicKeysCommand";
36
37
  import { ListStagesCommandInput, ListStagesCommandOutput } from "./commands/ListStagesCommand";
@@ -38,7 +39,9 @@ import { ListStageSessionsCommandInput, ListStageSessionsCommandOutput } from ".
38
39
  import { ListStorageConfigurationsCommandInput, ListStorageConfigurationsCommandOutput } from "./commands/ListStorageConfigurationsCommand";
39
40
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
40
41
  import { StartCompositionCommandInput, StartCompositionCommandOutput } from "./commands/StartCompositionCommand";
42
+ import { StartParticipantReplicationCommandInput, StartParticipantReplicationCommandOutput } from "./commands/StartParticipantReplicationCommand";
41
43
  import { StopCompositionCommandInput, StopCompositionCommandOutput } from "./commands/StopCompositionCommand";
44
+ import { StopParticipantReplicationCommandInput, StopParticipantReplicationCommandOutput } from "./commands/StopParticipantReplicationCommand";
42
45
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
43
46
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
44
47
  import { UpdateIngestConfigurationCommandInput, UpdateIngestConfigurationCommandOutput } from "./commands/UpdateIngestConfigurationCommand";
@@ -49,11 +52,11 @@ export { __Client };
49
52
  /**
50
53
  * @public
51
54
  */
52
- export type ServiceInputTypes = CreateEncoderConfigurationCommandInput | CreateIngestConfigurationCommandInput | CreateParticipantTokenCommandInput | CreateStageCommandInput | CreateStorageConfigurationCommandInput | DeleteEncoderConfigurationCommandInput | DeleteIngestConfigurationCommandInput | DeletePublicKeyCommandInput | DeleteStageCommandInput | DeleteStorageConfigurationCommandInput | DisconnectParticipantCommandInput | GetCompositionCommandInput | GetEncoderConfigurationCommandInput | GetIngestConfigurationCommandInput | GetParticipantCommandInput | GetPublicKeyCommandInput | GetStageCommandInput | GetStageSessionCommandInput | GetStorageConfigurationCommandInput | ImportPublicKeyCommandInput | ListCompositionsCommandInput | ListEncoderConfigurationsCommandInput | ListIngestConfigurationsCommandInput | ListParticipantEventsCommandInput | ListParticipantsCommandInput | ListPublicKeysCommandInput | ListStageSessionsCommandInput | ListStagesCommandInput | ListStorageConfigurationsCommandInput | ListTagsForResourceCommandInput | StartCompositionCommandInput | StopCompositionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateIngestConfigurationCommandInput | UpdateStageCommandInput;
55
+ export type ServiceInputTypes = CreateEncoderConfigurationCommandInput | CreateIngestConfigurationCommandInput | CreateParticipantTokenCommandInput | CreateStageCommandInput | CreateStorageConfigurationCommandInput | DeleteEncoderConfigurationCommandInput | DeleteIngestConfigurationCommandInput | DeletePublicKeyCommandInput | DeleteStageCommandInput | DeleteStorageConfigurationCommandInput | DisconnectParticipantCommandInput | GetCompositionCommandInput | GetEncoderConfigurationCommandInput | GetIngestConfigurationCommandInput | GetParticipantCommandInput | GetPublicKeyCommandInput | GetStageCommandInput | GetStageSessionCommandInput | GetStorageConfigurationCommandInput | ImportPublicKeyCommandInput | ListCompositionsCommandInput | ListEncoderConfigurationsCommandInput | ListIngestConfigurationsCommandInput | ListParticipantEventsCommandInput | ListParticipantReplicasCommandInput | ListParticipantsCommandInput | ListPublicKeysCommandInput | ListStageSessionsCommandInput | ListStagesCommandInput | ListStorageConfigurationsCommandInput | ListTagsForResourceCommandInput | StartCompositionCommandInput | StartParticipantReplicationCommandInput | StopCompositionCommandInput | StopParticipantReplicationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateIngestConfigurationCommandInput | UpdateStageCommandInput;
53
56
  /**
54
57
  * @public
55
58
  */
56
- export type ServiceOutputTypes = CreateEncoderConfigurationCommandOutput | CreateIngestConfigurationCommandOutput | CreateParticipantTokenCommandOutput | CreateStageCommandOutput | CreateStorageConfigurationCommandOutput | DeleteEncoderConfigurationCommandOutput | DeleteIngestConfigurationCommandOutput | DeletePublicKeyCommandOutput | DeleteStageCommandOutput | DeleteStorageConfigurationCommandOutput | DisconnectParticipantCommandOutput | GetCompositionCommandOutput | GetEncoderConfigurationCommandOutput | GetIngestConfigurationCommandOutput | GetParticipantCommandOutput | GetPublicKeyCommandOutput | GetStageCommandOutput | GetStageSessionCommandOutput | GetStorageConfigurationCommandOutput | ImportPublicKeyCommandOutput | ListCompositionsCommandOutput | ListEncoderConfigurationsCommandOutput | ListIngestConfigurationsCommandOutput | ListParticipantEventsCommandOutput | ListParticipantsCommandOutput | ListPublicKeysCommandOutput | ListStageSessionsCommandOutput | ListStagesCommandOutput | ListStorageConfigurationsCommandOutput | ListTagsForResourceCommandOutput | StartCompositionCommandOutput | StopCompositionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateIngestConfigurationCommandOutput | UpdateStageCommandOutput;
59
+ export type ServiceOutputTypes = CreateEncoderConfigurationCommandOutput | CreateIngestConfigurationCommandOutput | CreateParticipantTokenCommandOutput | CreateStageCommandOutput | CreateStorageConfigurationCommandOutput | DeleteEncoderConfigurationCommandOutput | DeleteIngestConfigurationCommandOutput | DeletePublicKeyCommandOutput | DeleteStageCommandOutput | DeleteStorageConfigurationCommandOutput | DisconnectParticipantCommandOutput | GetCompositionCommandOutput | GetEncoderConfigurationCommandOutput | GetIngestConfigurationCommandOutput | GetParticipantCommandOutput | GetPublicKeyCommandOutput | GetStageCommandOutput | GetStageSessionCommandOutput | GetStorageConfigurationCommandOutput | ImportPublicKeyCommandOutput | ListCompositionsCommandOutput | ListEncoderConfigurationsCommandOutput | ListIngestConfigurationsCommandOutput | ListParticipantEventsCommandOutput | ListParticipantReplicasCommandOutput | ListParticipantsCommandOutput | ListPublicKeysCommandOutput | ListStageSessionsCommandOutput | ListStagesCommandOutput | ListStorageConfigurationsCommandOutput | ListTagsForResourceCommandOutput | StartCompositionCommandOutput | StartParticipantReplicationCommandOutput | StopCompositionCommandOutput | StopParticipantReplicationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateIngestConfigurationCommandOutput | UpdateStageCommandOutput;
57
60
  /**
58
61
  * @public
59
62
  */
@@ -244,6 +247,29 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
244
247
  * including how participants are positioned in the video.</p>
245
248
  * </li>
246
249
  * </ul>
250
+ * <p>For participant replication:</p>
251
+ * <ul>
252
+ * <li>
253
+ * <p>
254
+ * <b>Source stage</b> — The stage where the participant originally joined, which is used as the source for
255
+ * replication.</p>
256
+ * </li>
257
+ * <li>
258
+ * <p>
259
+ * <b>Destination stage</b> — The stage to which the participant is replicated.
260
+ * </p>
261
+ * </li>
262
+ * <li>
263
+ * <p>
264
+ * <b>Replicated participant</b> — A participant in a stage that is replicated to one or more destination stages.
265
+ * </p>
266
+ * </li>
267
+ * <li>
268
+ * <p>
269
+ * <b>Replica participant</b> — A participant in a destination stage that is replicated from another stage
270
+ * (the source stage).</p>
271
+ * </li>
272
+ * </ul>
247
273
  * <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>
248
274
  * <p>
249
275
  * <b>Tagging</b>
@@ -67,6 +67,7 @@ declare const CreateStageCommand_base: {
67
67
  * hlsConfiguration: { // ParticipantRecordingHlsConfiguration
68
68
  * targetSegmentDurationSeconds: Number("int"),
69
69
  * },
70
+ * recordParticipantReplicas: true || false,
70
71
  * },
71
72
  * };
72
73
  * const command = new CreateStageCommand(input);
@@ -95,6 +96,7 @@ declare const CreateStageCommand_base: {
95
96
  * // hlsConfiguration: { // ParticipantRecordingHlsConfiguration
96
97
  * // targetSegmentDurationSeconds: Number("int"),
97
98
  * // },
99
+ * // recordParticipantReplicas: true || false,
98
100
  * // },
99
101
  * // endpoints: { // StageEndpoints
100
102
  * // events: "STRING_VALUE",
@@ -61,6 +61,10 @@ declare const GetParticipantCommand_base: {
61
61
  * // recordingS3Prefix: "STRING_VALUE",
62
62
  * // recordingState: "STRING_VALUE",
63
63
  * // protocol: "UNKNOWN" || "WHIP" || "RTMP" || "RTMPS",
64
+ * // replicationType: "STRING_VALUE",
65
+ * // replicationState: "STRING_VALUE",
66
+ * // sourceStageArn: "STRING_VALUE",
67
+ * // sourceSessionId: "STRING_VALUE",
64
68
  * // },
65
69
  * // };
66
70
  *
@@ -63,6 +63,7 @@ declare const GetStageCommand_base: {
63
63
  * // hlsConfiguration: { // ParticipantRecordingHlsConfiguration
64
64
  * // targetSegmentDurationSeconds: Number("int"),
65
65
  * // },
66
+ * // recordParticipantReplicas: true || false,
66
67
  * // },
67
68
  * // endpoints: { // StageEndpoints
68
69
  * // events: "STRING_VALUE",
@@ -52,6 +52,9 @@ declare const ListParticipantEventsCommand_base: {
52
52
  * // eventTime: new Date("TIMESTAMP"),
53
53
  * // remoteParticipantId: "STRING_VALUE",
54
54
  * // errorCode: "INSUFFICIENT_CAPABILITIES" || "QUOTA_EXCEEDED" || "PUBLISHER_NOT_FOUND" || "BITRATE_EXCEEDED" || "RESOLUTION_EXCEEDED" || "STREAM_DURATION_EXCEEDED" || "INVALID_AUDIO_CODEC" || "INVALID_VIDEO_CODEC" || "INVALID_PROTOCOL" || "INVALID_STREAM_KEY" || "REUSE_OF_STREAM_KEY" || "B_FRAME_PRESENT" || "INVALID_INPUT" || "INTERNAL_SERVER_EXCEPTION",
55
+ * // destinationStageArn: "STRING_VALUE",
56
+ * // destinationSessionId: "STRING_VALUE",
57
+ * // replica: true || false,
55
58
  * // },
56
59
  * // ],
57
60
  * // nextToken: "STRING_VALUE",
@@ -0,0 +1,91 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
4
+ import { ListParticipantReplicasRequest, ListParticipantReplicasResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListParticipantReplicasCommand}.
14
+ */
15
+ export interface ListParticipantReplicasCommandInput extends ListParticipantReplicasRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListParticipantReplicasCommand}.
21
+ */
22
+ export interface ListParticipantReplicasCommandOutput extends ListParticipantReplicasResponse, __MetadataBearer {
23
+ }
24
+ declare const ListParticipantReplicasCommand_base: {
25
+ new (input: ListParticipantReplicasCommandInput): import("@smithy/smithy-client").CommandImpl<ListParticipantReplicasCommandInput, ListParticipantReplicasCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ListParticipantReplicasCommandInput): import("@smithy/smithy-client").CommandImpl<ListParticipantReplicasCommandInput, ListParticipantReplicasCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists all the replicas for a participant from a source stage.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IVSRealTimeClient, ListParticipantReplicasCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
35
+ * // const { IVSRealTimeClient, ListParticipantReplicasCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
36
+ * const client = new IVSRealTimeClient(config);
37
+ * const input = { // ListParticipantReplicasRequest
38
+ * sourceStageArn: "STRING_VALUE", // required
39
+ * participantId: "STRING_VALUE", // required
40
+ * nextToken: "STRING_VALUE",
41
+ * maxResults: Number("int"),
42
+ * };
43
+ * const command = new ListParticipantReplicasCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // ListParticipantReplicasResponse
46
+ * // replicas: [ // ParticipantReplicaList // required
47
+ * // { // ParticipantReplica
48
+ * // sourceStageArn: "STRING_VALUE", // required
49
+ * // participantId: "STRING_VALUE", // required
50
+ * // sourceSessionId: "STRING_VALUE", // required
51
+ * // destinationStageArn: "STRING_VALUE", // required
52
+ * // destinationSessionId: "STRING_VALUE", // required
53
+ * // replicationState: "STRING_VALUE", // required
54
+ * // },
55
+ * // ],
56
+ * // nextToken: "STRING_VALUE",
57
+ * // };
58
+ *
59
+ * ```
60
+ *
61
+ * @param ListParticipantReplicasCommandInput - {@link ListParticipantReplicasCommandInput}
62
+ * @returns {@link ListParticipantReplicasCommandOutput}
63
+ * @see {@link ListParticipantReplicasCommandInput} for command's `input` shape.
64
+ * @see {@link ListParticipantReplicasCommandOutput} for command's `response` shape.
65
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
66
+ *
67
+ * @throws {@link AccessDeniedException} (client fault)
68
+ * <p/>
69
+ *
70
+ * @throws {@link ValidationException} (client fault)
71
+ * <p/>
72
+ *
73
+ * @throws {@link IVSRealTimeServiceException}
74
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
75
+ *
76
+ *
77
+ * @public
78
+ */
79
+ export declare class ListParticipantReplicasCommand extends ListParticipantReplicasCommand_base {
80
+ /** @internal type navigation helper, not in runtime. */
81
+ protected static __types: {
82
+ api: {
83
+ input: ListParticipantReplicasRequest;
84
+ output: ListParticipantReplicasResponse;
85
+ };
86
+ sdk: {
87
+ input: ListParticipantReplicasCommandInput;
88
+ output: ListParticipantReplicasCommandOutput;
89
+ };
90
+ };
91
+ }
@@ -55,6 +55,10 @@ declare const ListParticipantsCommand_base: {
55
55
  * // firstJoinTime: new Date("TIMESTAMP"),
56
56
  * // published: true || false,
57
57
  * // recordingState: "STRING_VALUE",
58
+ * // replicationType: "STRING_VALUE",
59
+ * // replicationState: "STRING_VALUE",
60
+ * // sourceStageArn: "STRING_VALUE",
61
+ * // sourceSessionId: "STRING_VALUE",
58
62
  * // },
59
63
  * // ],
60
64
  * // nextToken: "STRING_VALUE",
@@ -0,0 +1,105 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
4
+ import { StartParticipantReplicationRequest, StartParticipantReplicationResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartParticipantReplicationCommand}.
14
+ */
15
+ export interface StartParticipantReplicationCommandInput extends StartParticipantReplicationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartParticipantReplicationCommand}.
21
+ */
22
+ export interface StartParticipantReplicationCommandOutput extends StartParticipantReplicationResponse, __MetadataBearer {
23
+ }
24
+ declare const StartParticipantReplicationCommand_base: {
25
+ new (input: StartParticipantReplicationCommandInput): import("@smithy/smithy-client").CommandImpl<StartParticipantReplicationCommandInput, StartParticipantReplicationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: StartParticipantReplicationCommandInput): import("@smithy/smithy-client").CommandImpl<StartParticipantReplicationCommandInput, StartParticipantReplicationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Starts replicating a publishing participant from a source stage to a destination stage.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IVSRealTimeClient, StartParticipantReplicationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
35
+ * // const { IVSRealTimeClient, StartParticipantReplicationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
36
+ * const client = new IVSRealTimeClient(config);
37
+ * const input = { // StartParticipantReplicationRequest
38
+ * sourceStageArn: "STRING_VALUE", // required
39
+ * destinationStageArn: "STRING_VALUE", // required
40
+ * participantId: "STRING_VALUE", // required
41
+ * reconnectWindowSeconds: Number("int"),
42
+ * attributes: { // ParticipantAttributes
43
+ * "<keys>": "STRING_VALUE",
44
+ * },
45
+ * };
46
+ * const command = new StartParticipantReplicationCommand(input);
47
+ * const response = await client.send(command);
48
+ * // { // StartParticipantReplicationResponse
49
+ * // accessControlAllowOrigin: "STRING_VALUE",
50
+ * // accessControlExposeHeaders: "STRING_VALUE",
51
+ * // cacheControl: "STRING_VALUE",
52
+ * // contentSecurityPolicy: "STRING_VALUE",
53
+ * // strictTransportSecurity: "STRING_VALUE",
54
+ * // xContentTypeOptions: "STRING_VALUE",
55
+ * // xFrameOptions: "STRING_VALUE",
56
+ * // };
57
+ *
58
+ * ```
59
+ *
60
+ * @param StartParticipantReplicationCommandInput - {@link StartParticipantReplicationCommandInput}
61
+ * @returns {@link StartParticipantReplicationCommandOutput}
62
+ * @see {@link StartParticipantReplicationCommandInput} for command's `input` shape.
63
+ * @see {@link StartParticipantReplicationCommandOutput} for command's `response` shape.
64
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
65
+ *
66
+ * @throws {@link AccessDeniedException} (client fault)
67
+ * <p/>
68
+ *
69
+ * @throws {@link ConflictException} (client fault)
70
+ * <p/>
71
+ *
72
+ * @throws {@link InternalServerException} (server fault)
73
+ * <p/>
74
+ *
75
+ * @throws {@link PendingVerification} (client fault)
76
+ * <p/>
77
+ *
78
+ * @throws {@link ResourceNotFoundException} (client fault)
79
+ * <p/>
80
+ *
81
+ * @throws {@link ServiceQuotaExceededException} (client fault)
82
+ * <p/>
83
+ *
84
+ * @throws {@link ValidationException} (client fault)
85
+ * <p/>
86
+ *
87
+ * @throws {@link IVSRealTimeServiceException}
88
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
89
+ *
90
+ *
91
+ * @public
92
+ */
93
+ export declare class StartParticipantReplicationCommand extends StartParticipantReplicationCommand_base {
94
+ /** @internal type navigation helper, not in runtime. */
95
+ protected static __types: {
96
+ api: {
97
+ input: StartParticipantReplicationRequest;
98
+ output: StartParticipantReplicationResponse;
99
+ };
100
+ sdk: {
101
+ input: StartParticipantReplicationCommandInput;
102
+ output: StartParticipantReplicationCommandOutput;
103
+ };
104
+ };
105
+ }