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

*****************************
start_participant_replication
*****************************



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

  

  Starts replicating a publishing participant from a source stage to a destination stage.

  

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


  **Request Syntax**
  ::

    response = client.start_participant_replication(
        sourceStageArn='string',
        destinationStageArn='string',
        participantId='string',
        reconnectWindowSeconds=123,
        attributes={
            'string': 'string'
        }
    )
    
  :type sourceStageArn: string
  :param sourceStageArn: **[REQUIRED]** 

    ARN of the stage where the participant is publishing.

    

  
  :type destinationStageArn: string
  :param destinationStageArn: **[REQUIRED]** 

    ARN of the stage to which the participant will be replicated.

    

  
  :type participantId: string
  :param participantId: **[REQUIRED]** 

    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>`__.

    

  
  :type reconnectWindowSeconds: integer
  :param reconnectWindowSeconds: 

    If the participant disconnects and then reconnects within the specified interval, replication will continue to be ``ACTIVE``. Default: 0.

    

  
  :type attributes: dict
  :param attributes: 

    Application-provided attributes to set on the replicated participant in the destination stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. *This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.*

     

    These attributes are merged with any attributes set for this participant when creating the token. If there is overlap in keys, the values in these attributes are replaced.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'accessControlAllowOrigin': 'string',
          'accessControlExposeHeaders': 'string',
          'cacheControl': 'string',
          'contentSecurityPolicy': 'string',
          'strictTransportSecurity': 'string',
          'xContentTypeOptions': 'string',
          'xFrameOptions': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **accessControlAllowOrigin** *(string) --* 
      

      - **accessControlExposeHeaders** *(string) --* 
      

      - **cacheControl** *(string) --* 
      

      - **contentSecurityPolicy** *(string) --* 
      

      - **strictTransportSecurity** *(string) --* 
      

      - **xContentTypeOptions** *(string) --* 
      

      - **xFrameOptions** *(string) --* 
  
  **Exceptions**
  
  *   :py:class:`ivsrealtime.Client.exceptions.ResourceNotFoundException`

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

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

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

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

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

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

  