Copyright | (c) 2013-2017 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 |
Language | Haskell2010 |
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.
- describeVoices :: DescribeVoices
- data DescribeVoices
- dvLanguageCode :: Lens' DescribeVoices (Maybe LanguageCode)
- dvNextToken :: Lens' DescribeVoices (Maybe Text)
- describeVoicesResponse :: Int -> DescribeVoicesResponse
- data DescribeVoicesResponse
- dvrsNextToken :: Lens' DescribeVoicesResponse (Maybe Text)
- dvrsVoices :: Lens' DescribeVoicesResponse [Voice]
- dvrsResponseStatus :: Lens' DescribeVoicesResponse Int
Creating a Request
describeVoices :: DescribeVoices Source #
Creates a value of DescribeVoices
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvLanguageCode
- 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.dvNextToken
- An opaque pagination token returned from the previousDescribeVoices
operation. If present, this indicates where to continue the listing.
data DescribeVoices Source #
See: describeVoices
smart constructor.
Request Lenses
dvLanguageCode :: 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.
dvNextToken :: Lens' DescribeVoices (Maybe Text) Source #
An opaque pagination token returned from the previous DescribeVoices
operation. If present, this indicates where to continue the listing.
Destructuring the Response
describeVoicesResponse Source #
Creates a value of DescribeVoicesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvrsNextToken
- The pagination token to use in the next request to continue the listing of voices.NextToken
is returned only if the response is truncated.dvrsVoices
- A list of voices with their properties.dvrsResponseStatus
- -- | The response status code.
data DescribeVoicesResponse Source #
See: describeVoicesResponse
smart constructor.
Response Lenses
dvrsNextToken :: 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.
dvrsVoices :: Lens' DescribeVoicesResponse [Voice] Source #
A list of voices with their properties.
dvrsResponseStatus :: Lens' DescribeVoicesResponse Int Source #
- - | The response status code.