ChimeSDKVoice / Client / get_voice_profile

get_voice_profile#

ChimeSDKVoice.Client.get_voice_profile(**kwargs)#

Retrieves the details of the specified voice profile.

See also: AWS API Documentation

Request Syntax

response = client.get_voice_profile(
    VoiceProfileId='string'
)
Parameters:

VoiceProfileId (string) –

[REQUIRED]

The voice profile ID.

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

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

  • ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

  • ChimeSDKVoice.Client.exceptions.ServiceFailureException