| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Polly.DescribeVoices
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 ( 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.
This operation returns paginated results.
Synopsis
- data DescribeVoices = DescribeVoices' {}
- newDescribeVoices :: DescribeVoices
- describeVoices_languageCode :: Lens' DescribeVoices (Maybe LanguageCode)
- describeVoices_engine :: Lens' DescribeVoices (Maybe Engine)
- describeVoices_nextToken :: Lens' DescribeVoices (Maybe Text)
- describeVoices_includeAdditionalLanguageCodes :: Lens' DescribeVoices (Maybe Bool)
- data DescribeVoicesResponse = DescribeVoicesResponse' {}
- newDescribeVoicesResponse :: Int -> DescribeVoicesResponse
- describeVoicesResponse_nextToken :: Lens' DescribeVoicesResponse (Maybe Text)
- describeVoicesResponse_voices :: Lens' DescribeVoicesResponse (Maybe [Voice])
- describeVoicesResponse_httpStatus :: Lens' DescribeVoicesResponse Int
Creating a Request
data DescribeVoices Source #
See: newDescribeVoices smart constructor.
Constructors
| DescribeVoices' | |
Fields
| |
Instances
newDescribeVoices :: DescribeVoices Source #
Create a value of DescribeVoices with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageCode:DescribeVoices', describeVoices_languageCode - 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.
$sel:engine:DescribeVoices', describeVoices_engine - Specifies the engine (standard or neural) used by Amazon Polly when
processing input text for speech synthesis.
$sel:nextToken:DescribeVoices', describeVoices_nextToken - An opaque pagination token returned from the previous DescribeVoices
operation. If present, this indicates where to continue the listing.
$sel:includeAdditionalLanguageCodes:DescribeVoices', describeVoices_includeAdditionalLanguageCodes - 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.
Request Lenses
describeVoices_languageCode :: Lens' DescribeVoices (Maybe LanguageCode) Source #
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.
describeVoices_engine :: Lens' DescribeVoices (Maybe Engine) Source #
Specifies the engine (standard or neural) used by Amazon Polly when
processing input text for speech synthesis.
describeVoices_nextToken :: Lens' DescribeVoices (Maybe Text) Source #
An opaque pagination token returned from the previous DescribeVoices
operation. If present, this indicates where to continue the listing.
describeVoices_includeAdditionalLanguageCodes :: Lens' DescribeVoices (Maybe Bool) Source #
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.
Destructuring the Response
data DescribeVoicesResponse Source #
See: newDescribeVoicesResponse smart constructor.
Constructors
| DescribeVoicesResponse' | |
Instances
newDescribeVoicesResponse Source #
Create a value of DescribeVoicesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeVoices', describeVoicesResponse_nextToken - The pagination token to use in the next request to continue the listing
of voices. NextToken is returned only if the response is truncated.
$sel:voices:DescribeVoicesResponse', describeVoicesResponse_voices - A list of voices with their properties.
$sel:httpStatus:DescribeVoicesResponse', describeVoicesResponse_httpStatus - The response's http status code.
Response Lenses
describeVoicesResponse_nextToken :: Lens' DescribeVoicesResponse (Maybe Text) Source #
The pagination token to use in the next request to continue the listing
of voices. NextToken is returned only if the response is truncated.
describeVoicesResponse_voices :: Lens' DescribeVoicesResponse (Maybe [Voice]) Source #
A list of voices with their properties.
describeVoicesResponse_httpStatus :: Lens' DescribeVoicesResponse Int Source #
The response's http status code.