ChimeSDKVoice / Client / list_voice_profile_domains

list_voice_profile_domains#

ChimeSDKVoice.Client.list_voice_profile_domains(**kwargs)#

Lists the specified voice profile domains in the administrator’s AWS account.

See also: AWS API Documentation

Request Syntax

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

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

  • MaxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceProfileDomains': [
        {
            'VoiceProfileDomainId': 'string',
            'VoiceProfileDomainArn': 'string',
            'Name': 'string',
            'Description': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • VoiceProfileDomains (list) –

      The list of voice profile domains.

      • (dict) –

        A high-level overview of a voice profile domain.

        • VoiceProfileDomainId (string) –

          The ID of the voice profile domain summary.

        • VoiceProfileDomainArn (string) –

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

        • Name (string) –

          The name of the voice profile domain summary.

        • Description (string) –

          Describes the voice profile domain summary.

        • CreatedTimestamp (datetime) –

          The time at which the voice profile domain summary was created.

        • UpdatedTimestamp (datetime) –

          The time at which the voice profile domain summary was last updated.

    • NextToken (string) –

      The token used to return the next page of results.

Exceptions