Connect / Client / create_instance

create_instance

Connect.Client.create_instance(**kwargs)

This API is in preview release for Connect Customer and is subject to change.

Initiates an Connect Customer instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Connect Customer.

For more information, see Create an Connect Customer instance in the Connect Customer Administrator Guide.

Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

See also: AWS API Documentation

Request Syntax

response = client.create_instance(
    ClientToken='string',
    IdentityManagementType='SAML'|'CONNECT_MANAGED'|'EXISTING_DIRECTORY',
    InstanceAlias='string',
    DirectoryId='string',
    InboundCallsEnabled=True|False,
    OutboundCallsEnabled=True|False,
    Tags={
        'string': 'string'
    }
)
Parameters:

  • ClientToken (string) –

    The idempotency token.

    This field is autopopulated if not provided.

  • IdentityManagementType (string) –

    [REQUIRED]

    The type of identity management for your Connect Customer users.

  • InstanceAlias (string) – The name for your instance.

  • DirectoryId (string) – The identifier for the directory.

  • InboundCallsEnabled (boolean) –

    [REQUIRED]

    Your contact center handles incoming contacts.

  • OutboundCallsEnabled (boolean) –

    [REQUIRED]

    Your contact center allows outbound calls.

  • Tags (dict) –

    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string'
}

Response Structure

  • (dict) –

    • Id (string) –

      The identifier for the instance.

    • Arn (string) –

      The Amazon Resource Name (ARN) of the instance.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.ServiceQuotaExceededException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException