ChimeSDKVoice / Client / list_voice_profiles

list_voice_profiles#

ChimeSDKVoice.Client.list_voice_profiles(**kwargs)#

Lists the voice profiles in a voice profile domain.

See also: AWS API Documentation

Request Syntax

response = client.list_voice_profiles(
    VoiceProfileDomainId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • VoiceProfileDomainId (string) –

    [REQUIRED]

    The ID of the voice profile domain.

  • NextToken (string) – The token used to retrieve the next page of results.

  • MaxResults (integer) – The maximum number of results in the request.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceProfiles': [
        {
            'VoiceProfileId': 'string',
            'VoiceProfileArn': 'string',
            'VoiceProfileDomainId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'ExpirationTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • VoiceProfiles (list) –

      The list of voice profiles.

      • (dict) –

        A high-level summary of a voice profile.

        • VoiceProfileId (string) –

          The ID of the voice profile in a voice profile summary.

        • VoiceProfileArn (string) –

          The ARN of the voice profile in a voice profile summary.

        • VoiceProfileDomainId (string) –

          The ID of the voice profile domain in a voice profile summary.

        • CreatedTimestamp (datetime) –

          The time at which a voice profile summary was created.

        • UpdatedTimestamp (datetime) –

          The time at which a voice profile summary was last updated.

        • ExpirationTimestamp (datetime) –

          Extends the life of the voice profile. You can use UpdateVoiceProfile to refresh an existing voice profile’s voice print and extend the life of the summary.

    • NextToken (string) –

      The token used to retrieve the next page of results.

Exceptions

  • ChimeSDKVoice.Client.exceptions.NotFoundException

  • ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

  • ChimeSDKVoice.Client.exceptions.ForbiddenException

  • ChimeSDKVoice.Client.exceptions.BadRequestException

  • ChimeSDKVoice.Client.exceptions.ThrottledClientException

  • ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

  • ChimeSDKVoice.Client.exceptions.ServiceFailureException