:doc:`ivsrealtime <../../ivs-realtime>` / Client / list_participant_replicas

*************************
list_participant_replicas
*************************



.. py:method:: ivsrealtime.Client.list_participant_replicas(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipantReplicas>`_  


  **Request Syntax**
  ::

    response = client.list_participant_replicas(
        sourceStageArn='string',
        participantId='string',
        nextToken='string',
        maxResults=123
    )
    
  :type sourceStageArn: string
  :param sourceStageArn: **[REQUIRED]** 

    ARN of the stage where the participant is publishing.

    

  
  :type participantId: string
  :param participantId: **[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 <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed>`__.

    

  
  :type nextToken: string
  :param nextToken: 

    The first participant to retrieve. This is used for pagination; see the ``nextToken`` response field.

    

  
  :type maxResults: integer
  :param maxResults: 

    Maximum number of results to return. Default: 50.

    

  
  
  :rtype: 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 <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed>`__.

            
          

          - **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**
  
  *   :py:class:`ivsrealtime.Client.exceptions.ValidationException`

  
  *   :py:class:`ivsrealtime.Client.exceptions.AccessDeniedException`

  