ChimeSDKVoice / Client / create_voice_profile

create_voice_profile#

ChimeSDKVoice.Client.create_voice_profile(**kwargs)#

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

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.create_voice_profile(
    SpeakerSearchTaskId='string'
)
Parameters:

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 requested voice profile.

      • 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.ResourceLimitExceededException

  • 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