describe_voices¶
Operation¶
async
¶
describe_voices(input: DescribeVoicesInput, plugins: list[Plugin] | None = None) -> DescribeVoicesOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeVoicesInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeVoicesOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for DescribeVoicesInput structure.
Attributes¶
class-attribute
instance-attribute
¶
engine: Engine | None = None
Specifies the engine (standard, neural, long-form or generative)
used by Amazon Polly when processing input text for speech synthesis.
class-attribute
instance-attribute
¶
include_additional_language_codes: bool = False
Boolean value indicating whether to return any bilingual voices that use
the specified language as an additional language. For instance, if you
request all languages that use US English (es-US), and there is an
Italian voice that speaks both Italian (it-IT) and US English, that
voice will be included if you specify yes but not if you specify no.
class-attribute
instance-attribute
¶
language_code: LanguageCode | None = None
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.
class-attribute
instance-attribute
¶
next_token: str | None = None
An opaque pagination token returned from the previous DescribeVoices
operation. If present, this indicates where to continue the listing.