:doc:`ivsrealtime <../../ivs-realtime>` / Paginator / ListParticipantReplicas

***********************
ListParticipantReplicas
***********************



.. py:class:: ivsrealtime.Paginator.ListParticipantReplicas

  ::

    
    paginator = client.get_paginator('list_participant_replicas')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ivsrealtime.Client.list_participant_replicas`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          sourceStageArn='string',
          participantId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :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) --* 

          A token to resume pagination.

          
    