amazonka-polly-2.0: Amazon Polly SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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

Creating a Request

data DescribeVoices Source #

See: newDescribeVoices smart constructor.

Constructors

DescribeVoices' 

Fields

  • engine :: Maybe Engine

    Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.

  • includeAdditionalLanguageCodes :: Maybe 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.

  • languageCode :: Maybe 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.

  • nextToken :: Maybe Text

    An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

Instances

Instances details
ToHeaders DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

ToPath DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

ToQuery DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

AWSPager DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

AWSRequest DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

Associated Types

type AWSResponse DescribeVoices #

Generic DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

Associated Types

type Rep DescribeVoices :: Type -> Type #

Read DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

Show DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

NFData DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

Methods

rnf :: DescribeVoices -> () #

Eq DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

Hashable DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

type AWSResponse DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

type Rep DescribeVoices Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

type Rep DescribeVoices = D1 ('MetaData "DescribeVoices" "Amazonka.Polly.DescribeVoices" "amazonka-polly-2.0-6sZiChgAXCB1QK3Mfr0Pfp" 'False) (C1 ('MetaCons "DescribeVoices'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Engine)) :*: S1 ('MetaSel ('Just "includeAdditionalLanguageCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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:

DescribeVoices, describeVoices_engine - Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.

$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.

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.

DescribeVoices, describeVoices_nextToken - An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

Request Lenses

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_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.

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_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.

Destructuring the Response

data DescribeVoicesResponse Source #

See: newDescribeVoicesResponse smart constructor.

Constructors

DescribeVoicesResponse' 

Fields

  • nextToken :: Maybe Text

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

  • voices :: Maybe [Voice]

    A list of voices with their properties.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeVoicesResponse Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

Associated Types

type Rep DescribeVoicesResponse :: Type -> Type #

Read DescribeVoicesResponse Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

Show DescribeVoicesResponse Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

NFData DescribeVoicesResponse Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

Methods

rnf :: DescribeVoicesResponse -> () #

Eq DescribeVoicesResponse Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

type Rep DescribeVoicesResponse Source # 
Instance details

Defined in Amazonka.Polly.DescribeVoices

type Rep DescribeVoicesResponse = D1 ('MetaData "DescribeVoicesResponse" "Amazonka.Polly.DescribeVoices" "amazonka-polly-2.0-6sZiChgAXCB1QK3Mfr0Pfp" 'False) (C1 ('MetaCons "DescribeVoicesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "voices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Voice])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:

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.