describe_voices¶
Operation¶
describe_voices
¶
describe_voices(request: DescribeVoicesInput | DescribeVoicesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVoicesInputDict]) -> 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 |
|---|---|---|---|
request
|
DescribeVoicesInput | DescribeVoicesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeVoicesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeVoicesOutput
|
An instance of |
describe_voices
async
¶
describe_voices(request: DescribeVoicesInput | DescribeVoicesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVoicesInputDict]) -> 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 |
|---|---|---|---|
request
|
DescribeVoicesInput | DescribeVoicesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeVoicesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeVoicesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeVoicesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeVoicesInput.
Attributes¶
engine
instance-attribute
¶
engine: str | None
Specifies the engine (standard, neural, long-form or generative)
used by Amazon Polly when processing input text for speech synthesis.
include_additional_language_codes
instance-attribute
¶
include_additional_language_codes: bool | None
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.
DescribeVoicesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVoicesInput structure.
Attributes¶
engine
class-attribute
instance-attribute
¶
engine: str | None = ...
Specifies the engine (standard, neural, long-form or generative)
used by Amazon Polly when processing input text for speech synthesis.
include_additional_language_codes
class-attribute
instance-attribute
¶
include_additional_language_codes: bool = ...
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.
Output¶
DescribeVoicesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVoicesOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The pagination token to use in the next request to continue the listing
of voices. NextToken is returned only if the response is truncated.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.