Connect / Client / replicate_instance

replicate_instance#

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 in the Amazon Connect Administrator Guide.

See also: AWS API Documentation

Request Syntax

response = client.replicate_instance(
    InstanceId='string',
    ReplicaRegion='string',
    ClientToken='string',
    ReplicaAlias='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId, or the entire ARN.

  • ReplicaRegion (string) –

    [REQUIRED]

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

  • ClientToken (string) –

    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.

    This field is autopopulated if not provided.

  • ReplicaAlias (string) –

    [REQUIRED]

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

Return type:

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