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

CreateVoiceProfileDomain

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

Important

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

Request Syntax


POST /voice-profile-domains HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "string",
   "Description": "string",
   "Name": "string",
   "ServerSideEncryptionConfiguration": { 
      "KmsKeyArn": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

The unique identifier for the client request. Use a different token for different domain creation requests.

Type: String

Pattern: ^[-_a-zA-Z0-9]*${2,64}$

Required: No

Description

A description of the voice profile domain.

Type: String

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

Required: No

Name

The name of the voice profile domain.

Type: String

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

Pattern: [a-zA-Z0-9 _.-]+

Required: Yes

ServerSideEncryptionConfiguration

The server-side encryption configuration for the request.

Type: ServerSideEncryptionConfiguration object

Required: Yes

Tags

The tags assigned to the domain.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "VoiceProfileDomain": { 
      "CreatedTimestamp": "string",
      "Description": "string",
      "Name": "string",
      "ServerSideEncryptionConfiguration": { 
         "KmsKeyArn": "string"
      },
      "UpdatedTimestamp": "string",
      "VoiceProfileDomainArn": "string",
      "VoiceProfileDomainId": "string"
   }
}

Response Elements

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

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

VoiceProfileDomain

The requested voice profile domain.

Type: VoiceProfileDomain object

Errors

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

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401