Amazon Connect Service

{'Tags': {'string': 'string'}}

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

Initiates an Amazon Connect 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 Amazon Connect.

Amazon Connect 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

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

type ClientToken

string

param ClientToken

The idempotency token.

type IdentityManagementType

string

param IdentityManagementType

[REQUIRED]

The type of identity management for your Amazon Connect users.

type InstanceAlias

string

param InstanceAlias

The name for your instance.

type DirectoryId

string

param DirectoryId

The identifier for the directory.

type InboundCallsEnabled

boolean

param InboundCallsEnabled

[REQUIRED]

Your contact center handles incoming contacts.

type OutboundCallsEnabled

boolean

param OutboundCallsEnabled

[REQUIRED]

Your contact center allows outbound calls.

type Tags

dict

param Tags

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

• (string) --

  • (string) --

rtype

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.

{'Instance': {'Tags': {'string': 'string'}}}

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

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

See also: AWS API Documentation

Request Syntax

client.describe_instance(
    InstanceId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

rtype

dict

returns

Response Syntax

{
    'Instance': {
        'Id': 'string',
        'Arn': 'string',
        'IdentityManagementType': 'SAML'|'CONNECT_MANAGED'|'EXISTING_DIRECTORY',
        'InstanceAlias': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'ServiceRole': 'string',
        'InstanceStatus': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED',
        'StatusReason': {
            'Message': 'string'
        },
        'InboundCallsEnabled': True|False,
        'OutboundCallsEnabled': True|False,
        'InstanceAccessUrl': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) --

  • Instance (dict) --

    The name of the instance.

    • Id (string) --

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the instance.

    • IdentityManagementType (string) --

      The identity management type.

    • InstanceAlias (string) --

      The alias of instance.

    • CreatedTime (datetime) --

      When the instance was created.

    • ServiceRole (string) --

      The service role of the instance.

    • InstanceStatus (string) --

      The state of the instance.

    • StatusReason (dict) --

      Relevant details why the instance was not successfully created.

      • Message (string) --

        The message.

    • InboundCallsEnabled (boolean) --

      Whether inbound calls are enabled.

    • OutboundCallsEnabled (boolean) --

      Whether outbound calls are enabled.

    • InstanceAccessUrl (string) --

      This URL allows contact center users to access the Amazon Connect admin website.

    • Tags (dict) --

      The tags of an instance.

      • (string) --

        • (string) --