ChimeSDKVoice / Client / update_voice_profile

update_voice_profile#

ChimeSDKVoice.Client.update_voice_profile(**kwargs)#

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

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.update_voice_profile(
    VoiceProfileId='string',
    SpeakerSearchTaskId='string'
)
Parameters:

  • VoiceProfileId (string) –

    [REQUIRED]

    The profile ID.

  • SpeakerSearchTaskId (string) –

    [REQUIRED]

    The ID of the speaker search task.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceProfile': {
        'VoiceProfileId': 'string',
        'VoiceProfileArn': 'string',
        'VoiceProfileDomainId': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'ExpirationTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • VoiceProfile (dict) –

      The updated voice profile settings.

      • VoiceProfileId (string) –

        The ID of the voice profile.

      • VoiceProfileArn (string) –

        The ARN of the voice profile.

      • VoiceProfileDomainId (string) –

        The ID of the domain that contains the voice profile.

      • CreatedTimestamp (datetime) –

        The time at which the voice profile was created and enrolled.

      • UpdatedTimestamp (datetime) –

        The time at which the voice profile was last updated.

      • ExpirationTimestamp (datetime) –

        The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile API.

Exceptions

  • ChimeSDKVoice.Client.exceptions.BadRequestException

  • ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

  • ChimeSDKVoice.Client.exceptions.ForbiddenException

  • ChimeSDKVoice.Client.exceptions.AccessDeniedException

  • ChimeSDKVoice.Client.exceptions.NotFoundException

  • ChimeSDKVoice.Client.exceptions.ConflictException

  • ChimeSDKVoice.Client.exceptions.GoneException

  • ChimeSDKVoice.Client.exceptions.ThrottledClientException

  • ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

  • ChimeSDKVoice.Client.exceptions.ServiceFailureException