@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.
- package/README.md +47 -0
- package/dist-cjs/index.js +190 -1
- package/dist-cjs/runtimeConfig.js +4 -1
- package/dist-es/IVSRealTime.js +6 -0
- package/dist-es/commands/ListParticipantReplicasCommand.js +22 -0
- package/dist-es/commands/StartParticipantReplicationCommand.js +22 -0
- package/dist-es/commands/StopParticipantReplicationCommand.js +22 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +11 -0
- package/dist-es/pagination/ListParticipantReplicasPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +108 -0
- package/dist-es/runtimeConfig.js +4 -1
- package/dist-types/IVSRealTime.d.ts +44 -0
- package/dist-types/IVSRealTimeClient.d.ts +28 -2
- package/dist-types/commands/CreateStageCommand.d.ts +2 -0
- package/dist-types/commands/GetParticipantCommand.d.ts +4 -0
- package/dist-types/commands/GetStageCommand.d.ts +1 -0
- package/dist-types/commands/ListParticipantEventsCommand.d.ts +3 -0
- package/dist-types/commands/ListParticipantReplicasCommand.d.ts +91 -0
- package/dist-types/commands/ListParticipantsCommand.d.ts +4 -0
- package/dist-types/commands/StartParticipantReplicationCommand.d.ts +105 -0
- package/dist-types/commands/StopParticipantReplicationCommand.d.ts +92 -0
- package/dist-types/commands/UpdateStageCommand.d.ts +2 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/index.d.ts +23 -0
- package/dist-types/models/models_0.d.ts +322 -4
- package/dist-types/pagination/ListParticipantReplicasPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/IVSRealTime.d.ts +51 -0
- package/dist-types/ts3.4/IVSRealTimeClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/ListParticipantReplicasCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartParticipantReplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StopParticipantReplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +75 -0
- package/dist-types/ts3.4/pagination/ListParticipantReplicasPaginator.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 +36 -0
- package/package.json +2 -2
|
@@ -0,0 +1,92 @@
|
|
|
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 { StopParticipantReplicationRequest, StopParticipantReplicationResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StopParticipantReplicationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StopParticipantReplicationCommandInput extends StopParticipantReplicationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StopParticipantReplicationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StopParticipantReplicationCommandOutput extends StopParticipantReplicationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const StopParticipantReplicationCommand_base: {
|
|
25
|
+
new (input: StopParticipantReplicationCommandInput): import("@smithy/smithy-client").CommandImpl<StopParticipantReplicationCommandInput, StopParticipantReplicationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: StopParticipantReplicationCommandInput): import("@smithy/smithy-client").CommandImpl<StopParticipantReplicationCommandInput, StopParticipantReplicationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Stops a replicated participant session.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { IVSRealTimeClient, StopParticipantReplicationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
35
|
+
* // const { IVSRealTimeClient, StopParticipantReplicationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
36
|
+
* const client = new IVSRealTimeClient(config);
|
|
37
|
+
* const input = { // StopParticipantReplicationRequest
|
|
38
|
+
* sourceStageArn: "STRING_VALUE", // required
|
|
39
|
+
* destinationStageArn: "STRING_VALUE", // required
|
|
40
|
+
* participantId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new StopParticipantReplicationCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // StopParticipantReplicationResponse
|
|
45
|
+
* // accessControlAllowOrigin: "STRING_VALUE",
|
|
46
|
+
* // accessControlExposeHeaders: "STRING_VALUE",
|
|
47
|
+
* // cacheControl: "STRING_VALUE",
|
|
48
|
+
* // contentSecurityPolicy: "STRING_VALUE",
|
|
49
|
+
* // strictTransportSecurity: "STRING_VALUE",
|
|
50
|
+
* // xContentTypeOptions: "STRING_VALUE",
|
|
51
|
+
* // xFrameOptions: "STRING_VALUE",
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param StopParticipantReplicationCommandInput - {@link StopParticipantReplicationCommandInput}
|
|
57
|
+
* @returns {@link StopParticipantReplicationCommandOutput}
|
|
58
|
+
* @see {@link StopParticipantReplicationCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link StopParticipantReplicationCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p/>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerException} (server fault)
|
|
66
|
+
* <p/>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
69
|
+
* <p/>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ValidationException} (client fault)
|
|
72
|
+
* <p/>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
export declare class StopParticipantReplicationCommand extends StopParticipantReplicationCommand_base {
|
|
81
|
+
/** @internal type navigation helper, not in runtime. */
|
|
82
|
+
protected static __types: {
|
|
83
|
+
api: {
|
|
84
|
+
input: StopParticipantReplicationRequest;
|
|
85
|
+
output: StopParticipantReplicationResponse;
|
|
86
|
+
};
|
|
87
|
+
sdk: {
|
|
88
|
+
input: StopParticipantReplicationCommandInput;
|
|
89
|
+
output: StopParticipantReplicationCommandOutput;
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
}
|
|
@@ -53,6 +53,7 @@ declare const UpdateStageCommand_base: {
|
|
|
53
53
|
* hlsConfiguration: { // ParticipantRecordingHlsConfiguration
|
|
54
54
|
* targetSegmentDurationSeconds: Number("int"),
|
|
55
55
|
* },
|
|
56
|
+
* recordParticipantReplicas: true || false,
|
|
56
57
|
* },
|
|
57
58
|
* };
|
|
58
59
|
* const command = new UpdateStageCommand(input);
|
|
@@ -81,6 +82,7 @@ declare const UpdateStageCommand_base: {
|
|
|
81
82
|
* // hlsConfiguration: { // ParticipantRecordingHlsConfiguration
|
|
82
83
|
* // targetSegmentDurationSeconds: Number("int"),
|
|
83
84
|
* // },
|
|
85
|
+
* // recordParticipantReplicas: true || false,
|
|
84
86
|
* // },
|
|
85
87
|
* // endpoints: { // StageEndpoints
|
|
86
88
|
* // events: "STRING_VALUE",
|
|
@@ -22,6 +22,7 @@ export * from "./ListCompositionsCommand";
|
|
|
22
22
|
export * from "./ListEncoderConfigurationsCommand";
|
|
23
23
|
export * from "./ListIngestConfigurationsCommand";
|
|
24
24
|
export * from "./ListParticipantEventsCommand";
|
|
25
|
+
export * from "./ListParticipantReplicasCommand";
|
|
25
26
|
export * from "./ListParticipantsCommand";
|
|
26
27
|
export * from "./ListPublicKeysCommand";
|
|
27
28
|
export * from "./ListStageSessionsCommand";
|
|
@@ -29,7 +30,9 @@ export * from "./ListStagesCommand";
|
|
|
29
30
|
export * from "./ListStorageConfigurationsCommand";
|
|
30
31
|
export * from "./ListTagsForResourceCommand";
|
|
31
32
|
export * from "./StartCompositionCommand";
|
|
33
|
+
export * from "./StartParticipantReplicationCommand";
|
|
32
34
|
export * from "./StopCompositionCommand";
|
|
35
|
+
export * from "./StopParticipantReplicationCommand";
|
|
33
36
|
export * from "./TagResourceCommand";
|
|
34
37
|
export * from "./UntagResourceCommand";
|
|
35
38
|
export * from "./UpdateIngestConfigurationCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -38,6 +38,29 @@
|
|
|
38
38
|
* including how participants are positioned in the video.</p>
|
|
39
39
|
* </li>
|
|
40
40
|
* </ul>
|
|
41
|
+
* <p>For participant replication:</p>
|
|
42
|
+
* <ul>
|
|
43
|
+
* <li>
|
|
44
|
+
* <p>
|
|
45
|
+
* <b>Source stage</b> — The stage where the participant originally joined, which is used as the source for
|
|
46
|
+
* replication.</p>
|
|
47
|
+
* </li>
|
|
48
|
+
* <li>
|
|
49
|
+
* <p>
|
|
50
|
+
* <b>Destination stage</b> — The stage to which the participant is replicated.
|
|
51
|
+
* </p>
|
|
52
|
+
* </li>
|
|
53
|
+
* <li>
|
|
54
|
+
* <p>
|
|
55
|
+
* <b>Replicated participant</b> — A participant in a stage that is replicated to one or more destination stages.
|
|
56
|
+
* </p>
|
|
57
|
+
* </li>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>
|
|
60
|
+
* <b>Replica participant</b> — A participant in a destination stage that is replicated from another stage
|
|
61
|
+
* (the source stage).</p>
|
|
62
|
+
* </li>
|
|
63
|
+
* </ul>
|
|
41
64
|
* <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>
|
|
42
65
|
* <p>
|
|
43
66
|
* <b>Tagging</b>
|
|
@@ -878,6 +878,12 @@ export interface AutoParticipantRecordingConfiguration {
|
|
|
878
878
|
* @public
|
|
879
879
|
*/
|
|
880
880
|
hlsConfiguration?: ParticipantRecordingHlsConfiguration | undefined;
|
|
881
|
+
/**
|
|
882
|
+
* <p>Optional field to disable replica participant recording. If this is set to <code>false</code> when a
|
|
883
|
+
* participant is a replica, replica participants are not recorded. Default: <code>true</code>.</p>
|
|
884
|
+
* @public
|
|
885
|
+
*/
|
|
886
|
+
recordParticipantReplicas?: boolean | undefined;
|
|
881
887
|
}
|
|
882
888
|
/**
|
|
883
889
|
* <p>Object specifying a participant token configuration in a stage.</p>
|
|
@@ -1256,9 +1262,7 @@ export type RecordingConfigurationFormat = (typeof RecordingConfigurationFormat)
|
|
|
1256
1262
|
*/
|
|
1257
1263
|
export interface CompositionRecordingHlsConfiguration {
|
|
1258
1264
|
/**
|
|
1259
|
-
* <p>Defines the target duration for recorded segments generated when using composite recording.
|
|
1260
|
-
* Segments may have durations shorter than the specified value when needed to ensure each segment
|
|
1261
|
-
* begins with a keyframe. Default: 2.</p>
|
|
1265
|
+
* <p>Defines the target duration for recorded segments generated when using composite recording. Default: 2.</p>
|
|
1262
1266
|
* @public
|
|
1263
1267
|
*/
|
|
1264
1268
|
targetSegmentDurationSeconds?: number | undefined;
|
|
@@ -1784,6 +1788,31 @@ export declare const ParticipantRecordingState: {
|
|
|
1784
1788
|
* @public
|
|
1785
1789
|
*/
|
|
1786
1790
|
export type ParticipantRecordingState = (typeof ParticipantRecordingState)[keyof typeof ParticipantRecordingState];
|
|
1791
|
+
/**
|
|
1792
|
+
* @public
|
|
1793
|
+
* @enum
|
|
1794
|
+
*/
|
|
1795
|
+
export declare const ReplicationState: {
|
|
1796
|
+
readonly ACTIVE: "ACTIVE";
|
|
1797
|
+
readonly STOPPED: "STOPPED";
|
|
1798
|
+
};
|
|
1799
|
+
/**
|
|
1800
|
+
* @public
|
|
1801
|
+
*/
|
|
1802
|
+
export type ReplicationState = (typeof ReplicationState)[keyof typeof ReplicationState];
|
|
1803
|
+
/**
|
|
1804
|
+
* @public
|
|
1805
|
+
* @enum
|
|
1806
|
+
*/
|
|
1807
|
+
export declare const ReplicationType: {
|
|
1808
|
+
readonly NONE: "NONE";
|
|
1809
|
+
readonly REPLICA: "REPLICA";
|
|
1810
|
+
readonly SOURCE: "SOURCE";
|
|
1811
|
+
};
|
|
1812
|
+
/**
|
|
1813
|
+
* @public
|
|
1814
|
+
*/
|
|
1815
|
+
export type ReplicationType = (typeof ReplicationType)[keyof typeof ReplicationType];
|
|
1787
1816
|
/**
|
|
1788
1817
|
* @public
|
|
1789
1818
|
* @enum
|
|
@@ -1878,7 +1907,11 @@ export interface Participant {
|
|
|
1878
1907
|
/**
|
|
1879
1908
|
* <p>S3 prefix of the S3 bucket where the participant is being recorded, if individual
|
|
1880
1909
|
* participant recording is enabled, or <code>""</code> (empty string), if recording is not
|
|
1881
|
-
* enabled
|
|
1910
|
+
* enabled. If individual participant recording merge is enabled, and if a stage publisher
|
|
1911
|
+
* disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as
|
|
1912
|
+
* the previous session. See
|
|
1913
|
+
* <a href="/ivs/latest/RealTimeUserGuide/rt-individual-participant-recording.html#ind-part-rec-merge-frag">
|
|
1914
|
+
* Merge Fragmented Individual Participant Recordings</a>.</p>
|
|
1882
1915
|
* @public
|
|
1883
1916
|
*/
|
|
1884
1917
|
recordingS3Prefix?: string | undefined;
|
|
@@ -1892,6 +1925,27 @@ export interface Participant {
|
|
|
1892
1925
|
* @public
|
|
1893
1926
|
*/
|
|
1894
1927
|
protocol?: ParticipantProtocol | undefined;
|
|
1928
|
+
/**
|
|
1929
|
+
* <p>Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: <code>NONE</code>. </p>
|
|
1930
|
+
* @public
|
|
1931
|
+
*/
|
|
1932
|
+
replicationType?: ReplicationType | undefined;
|
|
1933
|
+
/**
|
|
1934
|
+
* <p>The participant's replication state.</p>
|
|
1935
|
+
* @public
|
|
1936
|
+
*/
|
|
1937
|
+
replicationState?: ReplicationState | undefined;
|
|
1938
|
+
/**
|
|
1939
|
+
* <p>Source stage ARN from which this participant is replicated, if <code>replicationType</code> is <code>REPLICA</code>.
|
|
1940
|
+
* </p>
|
|
1941
|
+
* @public
|
|
1942
|
+
*/
|
|
1943
|
+
sourceStageArn?: string | undefined;
|
|
1944
|
+
/**
|
|
1945
|
+
* <p>ID of the session within the source stage, if <code>replicationType</code> is <code>REPLICA</code>.</p>
|
|
1946
|
+
* @public
|
|
1947
|
+
*/
|
|
1948
|
+
sourceSessionId?: string | undefined;
|
|
1895
1949
|
}
|
|
1896
1950
|
/**
|
|
1897
1951
|
* @public
|
|
@@ -2411,6 +2465,8 @@ export declare const EventName: {
|
|
|
2411
2465
|
readonly PUBLISH_ERROR: "PUBLISH_ERROR";
|
|
2412
2466
|
readonly PUBLISH_STARTED: "PUBLISH_STARTED";
|
|
2413
2467
|
readonly PUBLISH_STOPPED: "PUBLISH_STOPPED";
|
|
2468
|
+
readonly REPLICATION_STARTED: "REPLICATION_STARTED";
|
|
2469
|
+
readonly REPLICATION_STOPPED: "REPLICATION_STOPPED";
|
|
2414
2470
|
readonly SUBSCRIBE_ERROR: "SUBSCRIBE_ERROR";
|
|
2415
2471
|
readonly SUBSCRIBE_STARTED: "SUBSCRIBE_STARTED";
|
|
2416
2472
|
readonly SUBSCRIBE_STOPPED: "SUBSCRIBE_STOPPED";
|
|
@@ -2536,6 +2592,24 @@ export interface Event {
|
|
|
2536
2592
|
* @public
|
|
2537
2593
|
*/
|
|
2538
2594
|
errorCode?: EventErrorCode | undefined;
|
|
2595
|
+
/**
|
|
2596
|
+
* <p>ARN of the stage where the participant is replicated. Applicable only if the event name is
|
|
2597
|
+
* <code>REPLICATION_STARTED</code> or <code>REPLICATION_STOPPED</code>.</p>
|
|
2598
|
+
* @public
|
|
2599
|
+
*/
|
|
2600
|
+
destinationStageArn?: string | undefined;
|
|
2601
|
+
/**
|
|
2602
|
+
* <p>ID of the session within the destination stage. Applicable only if the event name is
|
|
2603
|
+
* <code>REPLICATION_STARTED</code> or <code>REPLICATION_STOPPED</code>.</p>
|
|
2604
|
+
* @public
|
|
2605
|
+
*/
|
|
2606
|
+
destinationSessionId?: string | undefined;
|
|
2607
|
+
/**
|
|
2608
|
+
* <p>If true, this indicates the <code>participantId</code> is a replicated participant.
|
|
2609
|
+
* If this is a subscribe event, then this flag refers to <code>remoteParticipantId</code>.</p>
|
|
2610
|
+
* @public
|
|
2611
|
+
*/
|
|
2612
|
+
replica?: boolean | undefined;
|
|
2539
2613
|
}
|
|
2540
2614
|
/**
|
|
2541
2615
|
* @public
|
|
@@ -2553,6 +2627,87 @@ export interface ListParticipantEventsResponse {
|
|
|
2553
2627
|
*/
|
|
2554
2628
|
nextToken?: string | undefined;
|
|
2555
2629
|
}
|
|
2630
|
+
/**
|
|
2631
|
+
* @public
|
|
2632
|
+
*/
|
|
2633
|
+
export interface ListParticipantReplicasRequest {
|
|
2634
|
+
/**
|
|
2635
|
+
* <p>ARN of the stage where the participant is publishing.</p>
|
|
2636
|
+
* @public
|
|
2637
|
+
*/
|
|
2638
|
+
sourceStageArn: string | undefined;
|
|
2639
|
+
/**
|
|
2640
|
+
* <p>Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by
|
|
2641
|
+
* <a>CreateParticipantToken</a>
|
|
2642
|
+
* or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed">create a self signed token</a>.</p>
|
|
2643
|
+
* @public
|
|
2644
|
+
*/
|
|
2645
|
+
participantId: string | undefined;
|
|
2646
|
+
/**
|
|
2647
|
+
* <p>The first participant to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
|
|
2648
|
+
* @public
|
|
2649
|
+
*/
|
|
2650
|
+
nextToken?: string | undefined;
|
|
2651
|
+
/**
|
|
2652
|
+
* <p>Maximum number of results to return. Default: 50.</p>
|
|
2653
|
+
* @public
|
|
2654
|
+
*/
|
|
2655
|
+
maxResults?: number | undefined;
|
|
2656
|
+
}
|
|
2657
|
+
/**
|
|
2658
|
+
* <p>Information about the replicated destination stage for a participant.</p>
|
|
2659
|
+
* @public
|
|
2660
|
+
*/
|
|
2661
|
+
export interface ParticipantReplica {
|
|
2662
|
+
/**
|
|
2663
|
+
* <p>ARN of the stage from which this participant is replicated.</p>
|
|
2664
|
+
* @public
|
|
2665
|
+
*/
|
|
2666
|
+
sourceStageArn: string | undefined;
|
|
2667
|
+
/**
|
|
2668
|
+
* <p>Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by
|
|
2669
|
+
* <a>CreateParticipantToken</a>
|
|
2670
|
+
* or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed">
|
|
2671
|
+
* create a self signed token</a>.</p>
|
|
2672
|
+
* @public
|
|
2673
|
+
*/
|
|
2674
|
+
participantId: string | undefined;
|
|
2675
|
+
/**
|
|
2676
|
+
* <p>ID of the session within the source stage.</p>
|
|
2677
|
+
* @public
|
|
2678
|
+
*/
|
|
2679
|
+
sourceSessionId: string | undefined;
|
|
2680
|
+
/**
|
|
2681
|
+
* <p>ARN of the stage where the participant is replicated.</p>
|
|
2682
|
+
* @public
|
|
2683
|
+
*/
|
|
2684
|
+
destinationStageArn: string | undefined;
|
|
2685
|
+
/**
|
|
2686
|
+
* <p>ID of the session within the destination stage.</p>
|
|
2687
|
+
* @public
|
|
2688
|
+
*/
|
|
2689
|
+
destinationSessionId: string | undefined;
|
|
2690
|
+
/**
|
|
2691
|
+
* <p>Replica’s current replication state.</p>
|
|
2692
|
+
* @public
|
|
2693
|
+
*/
|
|
2694
|
+
replicationState: ReplicationState | undefined;
|
|
2695
|
+
}
|
|
2696
|
+
/**
|
|
2697
|
+
* @public
|
|
2698
|
+
*/
|
|
2699
|
+
export interface ListParticipantReplicasResponse {
|
|
2700
|
+
/**
|
|
2701
|
+
* <p>List of all participant replicas.</p>
|
|
2702
|
+
* @public
|
|
2703
|
+
*/
|
|
2704
|
+
replicas: ParticipantReplica[] | undefined;
|
|
2705
|
+
/**
|
|
2706
|
+
* <p>If there are more participants than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
|
|
2707
|
+
* @public
|
|
2708
|
+
*/
|
|
2709
|
+
nextToken?: string | undefined;
|
|
2710
|
+
}
|
|
2556
2711
|
/**
|
|
2557
2712
|
* @public
|
|
2558
2713
|
* @enum
|
|
@@ -2664,6 +2819,26 @@ export interface ParticipantSummary {
|
|
|
2664
2819
|
* @public
|
|
2665
2820
|
*/
|
|
2666
2821
|
recordingState?: ParticipantRecordingState | undefined;
|
|
2822
|
+
/**
|
|
2823
|
+
* <p>Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: <code>NONE</code>. </p>
|
|
2824
|
+
* @public
|
|
2825
|
+
*/
|
|
2826
|
+
replicationType?: ReplicationType | undefined;
|
|
2827
|
+
/**
|
|
2828
|
+
* <p>The participant's replication state.</p>
|
|
2829
|
+
* @public
|
|
2830
|
+
*/
|
|
2831
|
+
replicationState?: ReplicationState | undefined;
|
|
2832
|
+
/**
|
|
2833
|
+
* <p>ARN of the stage from which this participant is replicated.</p>
|
|
2834
|
+
* @public
|
|
2835
|
+
*/
|
|
2836
|
+
sourceStageArn?: string | undefined;
|
|
2837
|
+
/**
|
|
2838
|
+
* <p>ID of the session within the source stage, if <code>replicationType</code> is <code>REPLICA</code>.</p>
|
|
2839
|
+
* @public
|
|
2840
|
+
*/
|
|
2841
|
+
sourceSessionId?: string | undefined;
|
|
2667
2842
|
}
|
|
2668
2843
|
/**
|
|
2669
2844
|
* @public
|
|
@@ -2985,6 +3160,86 @@ export interface StartCompositionResponse {
|
|
|
2985
3160
|
*/
|
|
2986
3161
|
composition?: Composition | undefined;
|
|
2987
3162
|
}
|
|
3163
|
+
/**
|
|
3164
|
+
* @public
|
|
3165
|
+
*/
|
|
3166
|
+
export interface StartParticipantReplicationRequest {
|
|
3167
|
+
/**
|
|
3168
|
+
* <p>ARN of the stage where the participant is publishing.</p>
|
|
3169
|
+
* @public
|
|
3170
|
+
*/
|
|
3171
|
+
sourceStageArn: string | undefined;
|
|
3172
|
+
/**
|
|
3173
|
+
* <p>ARN of the stage to which the participant will be replicated.</p>
|
|
3174
|
+
* @public
|
|
3175
|
+
*/
|
|
3176
|
+
destinationStageArn: string | undefined;
|
|
3177
|
+
/**
|
|
3178
|
+
* <p>Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by
|
|
3179
|
+
* <a>CreateParticipantToken</a>
|
|
3180
|
+
* or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed">create a self signed token</a>.
|
|
3181
|
+
* </p>
|
|
3182
|
+
* @public
|
|
3183
|
+
*/
|
|
3184
|
+
participantId: string | undefined;
|
|
3185
|
+
/**
|
|
3186
|
+
* <p>If the participant disconnects and then reconnects within the specified interval, replication will continue to be <code>ACTIVE</code>.
|
|
3187
|
+
* Default: 0.</p>
|
|
3188
|
+
* @public
|
|
3189
|
+
*/
|
|
3190
|
+
reconnectWindowSeconds?: number | undefined;
|
|
3191
|
+
/**
|
|
3192
|
+
* <p>Application-provided attributes to set on the replicated participant in the destination stage.
|
|
3193
|
+
* Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
|
|
3194
|
+
* <i>This field is exposed to all stage participants and should not be used for personally identifying,
|
|
3195
|
+
* confidential, or sensitive information.</i>
|
|
3196
|
+
* </p>
|
|
3197
|
+
* <p>These attributes are merged with any attributes set for this participant when creating the token.
|
|
3198
|
+
* If there is overlap in keys, the values in these attributes are replaced.</p>
|
|
3199
|
+
* @public
|
|
3200
|
+
*/
|
|
3201
|
+
attributes?: Record<string, string> | undefined;
|
|
3202
|
+
}
|
|
3203
|
+
/**
|
|
3204
|
+
* @public
|
|
3205
|
+
*/
|
|
3206
|
+
export interface StartParticipantReplicationResponse {
|
|
3207
|
+
/**
|
|
3208
|
+
* <p/>
|
|
3209
|
+
* @public
|
|
3210
|
+
*/
|
|
3211
|
+
accessControlAllowOrigin?: string | undefined;
|
|
3212
|
+
/**
|
|
3213
|
+
* <p/>
|
|
3214
|
+
* @public
|
|
3215
|
+
*/
|
|
3216
|
+
accessControlExposeHeaders?: string | undefined;
|
|
3217
|
+
/**
|
|
3218
|
+
* <p/>
|
|
3219
|
+
* @public
|
|
3220
|
+
*/
|
|
3221
|
+
cacheControl?: string | undefined;
|
|
3222
|
+
/**
|
|
3223
|
+
* <p/>
|
|
3224
|
+
* @public
|
|
3225
|
+
*/
|
|
3226
|
+
contentSecurityPolicy?: string | undefined;
|
|
3227
|
+
/**
|
|
3228
|
+
* <p/>
|
|
3229
|
+
* @public
|
|
3230
|
+
*/
|
|
3231
|
+
strictTransportSecurity?: string | undefined;
|
|
3232
|
+
/**
|
|
3233
|
+
* <p/>
|
|
3234
|
+
* @public
|
|
3235
|
+
*/
|
|
3236
|
+
xContentTypeOptions?: string | undefined;
|
|
3237
|
+
/**
|
|
3238
|
+
* <p/>
|
|
3239
|
+
* @public
|
|
3240
|
+
*/
|
|
3241
|
+
xFrameOptions?: string | undefined;
|
|
3242
|
+
}
|
|
2988
3243
|
/**
|
|
2989
3244
|
* @public
|
|
2990
3245
|
*/
|
|
@@ -3000,6 +3255,69 @@ export interface StopCompositionRequest {
|
|
|
3000
3255
|
*/
|
|
3001
3256
|
export interface StopCompositionResponse {
|
|
3002
3257
|
}
|
|
3258
|
+
/**
|
|
3259
|
+
* @public
|
|
3260
|
+
*/
|
|
3261
|
+
export interface StopParticipantReplicationRequest {
|
|
3262
|
+
/**
|
|
3263
|
+
* <p>ARN of the stage where the participant is publishing.</p>
|
|
3264
|
+
* @public
|
|
3265
|
+
*/
|
|
3266
|
+
sourceStageArn: string | undefined;
|
|
3267
|
+
/**
|
|
3268
|
+
* <p>ARN of the stage where the participant has been replicated.</p>
|
|
3269
|
+
* @public
|
|
3270
|
+
*/
|
|
3271
|
+
destinationStageArn: string | undefined;
|
|
3272
|
+
/**
|
|
3273
|
+
* <p>Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by
|
|
3274
|
+
* <a>CreateParticipantToken</a>
|
|
3275
|
+
* or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed">
|
|
3276
|
+
* create a self signed token</a>.</p>
|
|
3277
|
+
* @public
|
|
3278
|
+
*/
|
|
3279
|
+
participantId: string | undefined;
|
|
3280
|
+
}
|
|
3281
|
+
/**
|
|
3282
|
+
* @public
|
|
3283
|
+
*/
|
|
3284
|
+
export interface StopParticipantReplicationResponse {
|
|
3285
|
+
/**
|
|
3286
|
+
* <p/>
|
|
3287
|
+
* @public
|
|
3288
|
+
*/
|
|
3289
|
+
accessControlAllowOrigin?: string | undefined;
|
|
3290
|
+
/**
|
|
3291
|
+
* <p/>
|
|
3292
|
+
* @public
|
|
3293
|
+
*/
|
|
3294
|
+
accessControlExposeHeaders?: string | undefined;
|
|
3295
|
+
/**
|
|
3296
|
+
* <p/>
|
|
3297
|
+
* @public
|
|
3298
|
+
*/
|
|
3299
|
+
cacheControl?: string | undefined;
|
|
3300
|
+
/**
|
|
3301
|
+
* <p/>
|
|
3302
|
+
* @public
|
|
3303
|
+
*/
|
|
3304
|
+
contentSecurityPolicy?: string | undefined;
|
|
3305
|
+
/**
|
|
3306
|
+
* <p/>
|
|
3307
|
+
* @public
|
|
3308
|
+
*/
|
|
3309
|
+
strictTransportSecurity?: string | undefined;
|
|
3310
|
+
/**
|
|
3311
|
+
* <p/>
|
|
3312
|
+
* @public
|
|
3313
|
+
*/
|
|
3314
|
+
xContentTypeOptions?: string | undefined;
|
|
3315
|
+
/**
|
|
3316
|
+
* <p/>
|
|
3317
|
+
* @public
|
|
3318
|
+
*/
|
|
3319
|
+
xFrameOptions?: string | undefined;
|
|
3320
|
+
}
|
|
3003
3321
|
/**
|
|
3004
3322
|
* @public
|
|
3005
3323
|
*/
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListParticipantReplicasCommandInput, ListParticipantReplicasCommandOutput } from "../commands/ListParticipantReplicasCommand";
|
|
3
|
+
import { IVSRealTimePaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateListParticipantReplicas: (config: IVSRealTimePaginationConfiguration, input: ListParticipantReplicasCommandInput, ...rest: any[]) => Paginator<ListParticipantReplicasCommandOutput>;
|
|
@@ -3,6 +3,7 @@ export * from "./ListCompositionsPaginator";
|
|
|
3
3
|
export * from "./ListEncoderConfigurationsPaginator";
|
|
4
4
|
export * from "./ListIngestConfigurationsPaginator";
|
|
5
5
|
export * from "./ListParticipantEventsPaginator";
|
|
6
|
+
export * from "./ListParticipantReplicasPaginator";
|
|
6
7
|
export * from "./ListParticipantsPaginator";
|
|
7
8
|
export * from "./ListPublicKeysPaginator";
|
|
8
9
|
export * from "./ListStageSessionsPaginator";
|
|
@@ -24,6 +24,7 @@ import { ListCompositionsCommandInput, ListCompositionsCommandOutput } from "../
|
|
|
24
24
|
import { ListEncoderConfigurationsCommandInput, ListEncoderConfigurationsCommandOutput } from "../commands/ListEncoderConfigurationsCommand";
|
|
25
25
|
import { ListIngestConfigurationsCommandInput, ListIngestConfigurationsCommandOutput } from "../commands/ListIngestConfigurationsCommand";
|
|
26
26
|
import { ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput } from "../commands/ListParticipantEventsCommand";
|
|
27
|
+
import { ListParticipantReplicasCommandInput, ListParticipantReplicasCommandOutput } from "../commands/ListParticipantReplicasCommand";
|
|
27
28
|
import { ListParticipantsCommandInput, ListParticipantsCommandOutput } from "../commands/ListParticipantsCommand";
|
|
28
29
|
import { ListPublicKeysCommandInput, ListPublicKeysCommandOutput } from "../commands/ListPublicKeysCommand";
|
|
29
30
|
import { ListStagesCommandInput, ListStagesCommandOutput } from "../commands/ListStagesCommand";
|
|
@@ -31,7 +32,9 @@ import { ListStageSessionsCommandInput, ListStageSessionsCommandOutput } from ".
|
|
|
31
32
|
import { ListStorageConfigurationsCommandInput, ListStorageConfigurationsCommandOutput } from "../commands/ListStorageConfigurationsCommand";
|
|
32
33
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
|
|
33
34
|
import { StartCompositionCommandInput, StartCompositionCommandOutput } from "../commands/StartCompositionCommand";
|
|
35
|
+
import { StartParticipantReplicationCommandInput, StartParticipantReplicationCommandOutput } from "../commands/StartParticipantReplicationCommand";
|
|
34
36
|
import { StopCompositionCommandInput, StopCompositionCommandOutput } from "../commands/StopCompositionCommand";
|
|
37
|
+
import { StopParticipantReplicationCommandInput, StopParticipantReplicationCommandOutput } from "../commands/StopParticipantReplicationCommand";
|
|
35
38
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
|
|
36
39
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
|
|
37
40
|
import { UpdateIngestConfigurationCommandInput, UpdateIngestConfigurationCommandOutput } from "../commands/UpdateIngestConfigurationCommand";
|
|
@@ -132,6 +135,10 @@ export declare const se_ListIngestConfigurationsCommand: (input: ListIngestConfi
|
|
|
132
135
|
* serializeAws_restJson1ListParticipantEventsCommand
|
|
133
136
|
*/
|
|
134
137
|
export declare const se_ListParticipantEventsCommand: (input: ListParticipantEventsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
138
|
+
/**
|
|
139
|
+
* serializeAws_restJson1ListParticipantReplicasCommand
|
|
140
|
+
*/
|
|
141
|
+
export declare const se_ListParticipantReplicasCommand: (input: ListParticipantReplicasCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
135
142
|
/**
|
|
136
143
|
* serializeAws_restJson1ListParticipantsCommand
|
|
137
144
|
*/
|
|
@@ -160,10 +167,18 @@ export declare const se_ListTagsForResourceCommand: (input: ListTagsForResourceC
|
|
|
160
167
|
* serializeAws_restJson1StartCompositionCommand
|
|
161
168
|
*/
|
|
162
169
|
export declare const se_StartCompositionCommand: (input: StartCompositionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
170
|
+
/**
|
|
171
|
+
* serializeAws_restJson1StartParticipantReplicationCommand
|
|
172
|
+
*/
|
|
173
|
+
export declare const se_StartParticipantReplicationCommand: (input: StartParticipantReplicationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
163
174
|
/**
|
|
164
175
|
* serializeAws_restJson1StopCompositionCommand
|
|
165
176
|
*/
|
|
166
177
|
export declare const se_StopCompositionCommand: (input: StopCompositionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
178
|
+
/**
|
|
179
|
+
* serializeAws_restJson1StopParticipantReplicationCommand
|
|
180
|
+
*/
|
|
181
|
+
export declare const se_StopParticipantReplicationCommand: (input: StopParticipantReplicationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
167
182
|
/**
|
|
168
183
|
* serializeAws_restJson1TagResourceCommand
|
|
169
184
|
*/
|
|
@@ -276,6 +291,10 @@ export declare const de_ListIngestConfigurationsCommand: (output: __HttpResponse
|
|
|
276
291
|
* deserializeAws_restJson1ListParticipantEventsCommand
|
|
277
292
|
*/
|
|
278
293
|
export declare const de_ListParticipantEventsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListParticipantEventsCommandOutput>;
|
|
294
|
+
/**
|
|
295
|
+
* deserializeAws_restJson1ListParticipantReplicasCommand
|
|
296
|
+
*/
|
|
297
|
+
export declare const de_ListParticipantReplicasCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListParticipantReplicasCommandOutput>;
|
|
279
298
|
/**
|
|
280
299
|
* deserializeAws_restJson1ListParticipantsCommand
|
|
281
300
|
*/
|
|
@@ -304,10 +323,18 @@ export declare const de_ListTagsForResourceCommand: (output: __HttpResponse, con
|
|
|
304
323
|
* deserializeAws_restJson1StartCompositionCommand
|
|
305
324
|
*/
|
|
306
325
|
export declare const de_StartCompositionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StartCompositionCommandOutput>;
|
|
326
|
+
/**
|
|
327
|
+
* deserializeAws_restJson1StartParticipantReplicationCommand
|
|
328
|
+
*/
|
|
329
|
+
export declare const de_StartParticipantReplicationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StartParticipantReplicationCommandOutput>;
|
|
307
330
|
/**
|
|
308
331
|
* deserializeAws_restJson1StopCompositionCommand
|
|
309
332
|
*/
|
|
310
333
|
export declare const de_StopCompositionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StopCompositionCommandOutput>;
|
|
334
|
+
/**
|
|
335
|
+
* deserializeAws_restJson1StopParticipantReplicationCommand
|
|
336
|
+
*/
|
|
337
|
+
export declare const de_StopParticipantReplicationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StopParticipantReplicationCommandOutput>;
|
|
311
338
|
/**
|
|
312
339
|
* deserializeAws_restJson1TagResourceCommand
|
|
313
340
|
*/
|