Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateInstance

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 S3, or Kinesis) or allow for any configurations on features such as Contact Lens for Amazon Connect.

Request Syntax


PUT /instance HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "DirectoryId": "string",
   "IdentityManagementType": "string",
   "InboundCallsEnabled": boolean,
   "InstanceAlias": "string",
   "OutboundCallsEnabled": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken

The idempotency token.

Type: String

Length Constraints: Maximum length of 500.

Required: No

DirectoryId

The identifier for the directory.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^d-[0-9a-f]{10}$

Required: No

IdentityManagementType

The type of identity management for your Amazon Connect users.

Type: String

Valid Values: SAML | CONNECT_MANAGED | EXISTING_DIRECTORY

Required: Yes

InboundCallsEnabled

Whether your contact center handles incoming contacts.

Type: Boolean

Required: Yes

InstanceAlias

The name for your instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 62.

Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$

Required: No

OutboundCallsEnabled

Whether your contact center allows outbound calls.

Type: Boolean

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Id": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) of the instance.

Type: String

Id

The identifier for the instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed due to an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota has been exceeded.

HTTP Status Code: 402

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429