:doc:`Connect <../../connect>` / Client / replicate_instance

******************
replicate_instance
******************



.. py:method:: Connect.Client.replicate_instance(**kwargs)

  

  Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.

   

  For more information about replicating an Amazon Connect instance, see `Create a replica of your existing Amazon Connect instance <https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html>`__ in the *Amazon Connect Administrator Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReplicateInstance>`_  


  **Request Syntax**
  ::

    response = client.replicate_instance(
        InstanceId='string',
        ReplicaRegion='string',
        ClientToken='string',
        ReplicaAlias='string'
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance. You can provide the ``InstanceId``, or the entire ARN.

    

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

    The Amazon Web Services Region where to replicate the Amazon Connect instance.

    

  
  :type ClientToken: string
  :param ClientToken: 

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see `Making retries safe with idempotent APIs <https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/>`__.

    This field is autopopulated if not provided.

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

    The alias for the replicated instance. The ``ReplicaAlias`` must be unique.

    

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

    
    ::

      {
          'Id': 'string',
          'Arn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Id** *(string) --* 

        The identifier of the replicated instance. You can find the ``instanceId`` in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.

        
      

      - **Arn** *(string) --* 

        The Amazon Resource Name (ARN) of the replicated instance.

        
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

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

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

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceNotReadyException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceConflictException`

  