v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1439243197.0 KB

Lists all the replicas for a participant from a source stage.

post/ListParticipantReplicas

Request body

sourceStageArnstring required

ARN of the stage where the participant is publishing.

participantIdstring required

Participant ID of the publisher that has been 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>.

nextTokenstring

The first participant to retrieve. This is used for pagination; see the <code>nextToken</code> response field.

maxResultsinteger

Maximum number of results to return. Default: 50.

Response

Success

nextTokenstring

If there are more participants than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.