ivsrealtime / Paginator / ListParticipantReplicas

ListParticipantReplicas

class ivsrealtime.Paginator.ListParticipantReplicas

paginator = client.get_paginator('list_participant_replicas')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ivsrealtime.Client.list_participant_replicas().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    sourceStageArn='string',
    participantId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.