Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateDomain

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.

Request Syntax


{
   "ClientToken": "string",
   "Description": "string",
   "Name": "string",
   "ServerSideEncryptionConfiguration": { 
      "KmsKeyId": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

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

Pattern: ^[a-zA-Z0-9-_]+$

Required: No

Description

A brief description of this domain.

Type: String

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

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: No

Name

The name of the domain.

Type: String

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

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

Required: Yes

ServerSideEncryptionConfiguration

The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Refer to Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used.

Type: ServerSideEncryptionConfiguration object

Required: Yes

Tags

A list of tags you want added to the domain.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


{
   "Domain": { 
      "Arn": "string",
      "CreatedAt": number,
      "Description": "string",
      "DomainId": "string",
      "DomainStatus": "string",
      "Name": "string",
      "ServerSideEncryptionConfiguration": { 
         "KmsKeyId": "string"
      },
      "ServerSideEncryptionUpdateDetails": { 
         "Message": "string",
         "OldKmsKeyId": "string",
         "UpdateStatus": "string"
      },
      "UpdatedAt": number,
      "WatchlistDetails": { 
         "DefaultWatchlistId": "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.

Domain

Information about the newly created domain.

Type: Domain object

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action. Check the error message and try again.

HTTP Status Code: 400

ConflictException

The request failed due to a conflict. Check the ConflictType and error message for more details.

HTTP Status Code: 400

InternalServerException

The request failed due to an unknown error on the server side.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found. Check the ResourceType and error message for more details.

HTTP Status Code: 400

ServiceQuotaExceededException

The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.

HTTP Status Code: 400

ValidationException

The request failed one or more validations; check the error message for more details.

HTTP Status Code: 400