IAmazonPolly.DescribeVoices Method (DescribeVoicesRequest)

Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name.

When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the voice you want from the list of voices returned by DescribeVoices.

For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the DescribeVoices operation you can provide the user with a list of available voices to select from.

You can optionally specify a language code to filter the available voices. For example, if you specify en-US, the operation returns a list of all available US English voices.

This operation requires permissions to perform the polly:DescribeVoices action.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DescribeVoicesAsync.

Namespace: Amazon.Polly
Assembly: AWSSDK.Polly.dll
Version: 3.x.y.z

Syntax

public abstract DescribeVoicesResponse DescribeVoices(
         DescribeVoicesRequest request
)

Parameters

request: Type: Amazon.Polly.Model.DescribeVoicesRequest

Container for the necessary parameters to execute the DescribeVoices service method.

Return Value

Type: DescribeVoicesResponse

The response from the DescribeVoices service method, as returned by Polly.

Exceptions

Exception	Condition
InvalidNextTokenException	The NextToken is invalid. Verify that it's spelled correctly, and then try again.
ServiceFailureException	An unknown condition has caused a service failure.

Examples

Returns the list of voices that are available for use when requesting speech synthesis. Displayed languages are those within the specified language code. If no language code is specified, voices for all available languages are displayed.

To describe available voices


var client = new AmazonPollyClient();
var response = client.DescribeVoices(new DescribeVoicesRequest 
{
    LanguageCode = "en-GB"
});

List<Voice> voices = response.Voices;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

IAmazonPolly.DescribeVoices (DescribeVoicesRequest)

Method