ivsrealtime / Client / list_participant_replicas

list_participant_replicas

ivsrealtime.Client.list_participant_replicas(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_participant_replicas(
    sourceStageArn='string',
    participantId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • sourceStageArn (string) –

    [REQUIRED]

    ARN of the stage where the participant is publishing.

  • participantId (string) –

    [REQUIRED]

    Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.

  • nextToken (string) – The first participant to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults (integer) – Maximum number of results to return. Default: 50.

Return type:

dict

Returns:

Response Syntax

{
    'replicas': [
        {
            'sourceStageArn': 'string',
            'participantId': 'string',
            'sourceSessionId': 'string',
            'destinationStageArn': 'string',
            'destinationSessionId': 'string',
            'replicationState': 'ACTIVE'|'STOPPED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • replicas (list) –

      List of all participant replicas.

      • (dict) –

        Information about the replicated destination stage for a participant.

        • sourceStageArn (string) –

          ARN of the stage from which this participant is replicated.

        • participantId (string) –

          Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.

        • sourceSessionId (string) –

          ID of the session within the source stage.

        • destinationStageArn (string) –

          ARN of the stage where the participant is replicated.

        • destinationSessionId (string) –

          ID of the session within the destination stage.

        • replicationState (string) –

          Replica’s current replication state.

    • nextToken (string) –

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

Exceptions