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

CreateVoiceProfile

Creates a voice profile, which consists of an enrolled user and their latest voice print.

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 profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

Request Syntax


POST /voice-profiles HTTP/1.1
Content-type: application/json

{
   "SpeakerSearchTaskId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

SpeakerSearchTaskId

The ID of the speaker search task.

Type: String

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

Pattern: .*\S.*

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "VoiceProfile": { 
      "CreatedTimestamp": "string",
      "ExpirationTimestamp": "string",
      "UpdatedTimestamp": "string",
      "VoiceProfileArn": "string",
      "VoiceProfileDomainId": "string",
      "VoiceProfileId": "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.

VoiceProfile

The requested voice profile.

Type: VoiceProfile 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

GoneException

Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.

HTTP Status Code: 410

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

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