Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1439243197.0 KB

Starts replicating a publishing participant from a source stage to a destination stage.

post/StartParticipantReplication

Request body

sourceStageArnstring required

ARN of the stage where the participant is publishing.

destinationStageArnstring required

ARN of the stage to which the participant will be replicated.

participantIdstring required

Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by <a>CreateParticipantToken</a> 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>.

reconnectWindowSecondsinteger

If the participant disconnects and then reconnects within the specified interval, replication will continue to be <code>ACTIVE</code>. Default: 0.

attributesobject
<p>Application-provided attributes to set on the replicated participant in the destination stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p> <p>These attributes are merged with any attributes set for this participant when creating the token. If there is overlap in keys, the values in these attributes are replaced.</p>

Response

Success

StartParticipantReplicationResponse required