Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . polly ]

describe-voices

Description

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 ( synthesize-speech ), you provide the voice ID for the voice you want from the list of voices returned by describe-voices .

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 describe-voices 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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-voices is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Voices

Synopsis

  describe-voices
[--language-code <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--language-code (string)

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

Possible values:

  • cy-GB
  • da-DK
  • de-DE
  • en-AU
  • en-GB
  • en-GB-WLS
  • en-IN
  • en-US
  • es-ES
  • es-US
  • fr-CA
  • fr-FR
  • is-IS
  • it-IT
  • ko-KR
  • ja-JP
  • nb-NO
  • nl-NL
  • pl-PL
  • pt-BR
  • pt-PT
  • ro-RO
  • ru-RU
  • sv-SE
  • tr-TR

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--starting-token (string)

A token to specify where to start paginating. This is the next-token from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a next-token is provided in the command's output. To resume pagination, provide the next-token value in the starting-token argument of a subsequent command. Do not use the next-token response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Voices -> (list)

A list of voices with their properties.

(structure)

Description of the voice.

Gender -> (string)

Gender of the voice.

Id -> (string)

Amazon Polly assigned voice ID. This is the ID that you specify when calling the synthesize-speech operation.

LanguageCode -> (string)

Language code of the voice.

LanguageName -> (string)

Human readable name of the language in English.

Name -> (string)

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

NextToken -> (string)

The pagination token to use in the next request to continue the listing of voices. next-token is returned only if the response is truncated.