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

UpdateVoiceProfile

Updates the specified voice profile’s voice print and refreshes its expiration timestamp.

Important

As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws.

You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.

Request Syntax


PUT /voice-profiles/VoiceProfileId HTTP/1.1
Content-type: application/json

{
   "SpeakerSearchTaskId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

VoiceProfileId

The profile ID.

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

Pattern: .*\S.*

Required: Yes

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 200
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 200 response.

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

VoiceProfile

The updated voice profile settings.

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

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