amazonka-polly-1.5.0: Amazon Polly SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Polly.DescribeVoices

Contents

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.

Synopsis

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 previous DescribeVoices operation. If present, this indicates where to continue the listing.

data DescribeVoices Source #

See: describeVoices smart constructor.

Instances

Eq DescribeVoices Source # 
Data DescribeVoices Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeVoices -> c DescribeVoices #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeVoices #

toConstr :: DescribeVoices -> Constr #

dataTypeOf :: DescribeVoices -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeVoices) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeVoices) #

gmapT :: (forall b. Data b => b -> b) -> DescribeVoices -> DescribeVoices #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVoices -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVoices -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeVoices -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeVoices -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeVoices -> m DescribeVoices #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVoices -> m DescribeVoices #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVoices -> m DescribeVoices #

Read DescribeVoices Source # 
Show DescribeVoices Source # 
Generic DescribeVoices Source # 

Associated Types

type Rep DescribeVoices :: * -> * #

Hashable DescribeVoices Source # 
NFData DescribeVoices Source # 

Methods

rnf :: DescribeVoices -> () #

AWSRequest DescribeVoices Source # 
ToQuery DescribeVoices Source # 
ToPath DescribeVoices Source # 
ToHeaders DescribeVoices Source # 
type Rep DescribeVoices Source # 
type Rep DescribeVoices = D1 (MetaData "DescribeVoices" "Network.AWS.Polly.DescribeVoices" "amazonka-polly-1.5.0-6GQgazTF7VkDmpcwDjBhon" False) (C1 (MetaCons "DescribeVoices'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dvLanguageCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LanguageCode))) (S1 (MetaSel (Just Symbol "_dvNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))
type Rs DescribeVoices Source # 

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.

Instances

Eq DescribeVoicesResponse Source # 
Data DescribeVoicesResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeVoicesResponse -> c DescribeVoicesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeVoicesResponse #

toConstr :: DescribeVoicesResponse -> Constr #

dataTypeOf :: DescribeVoicesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeVoicesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeVoicesResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeVoicesResponse -> DescribeVoicesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVoicesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVoicesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeVoicesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeVoicesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeVoicesResponse -> m DescribeVoicesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVoicesResponse -> m DescribeVoicesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVoicesResponse -> m DescribeVoicesResponse #

Read DescribeVoicesResponse Source # 
Show DescribeVoicesResponse Source # 
Generic DescribeVoicesResponse Source # 
NFData DescribeVoicesResponse Source # 

Methods

rnf :: DescribeVoicesResponse -> () #

type Rep DescribeVoicesResponse Source # 
type Rep DescribeVoicesResponse = D1 (MetaData "DescribeVoicesResponse" "Network.AWS.Polly.DescribeVoices" "amazonka-polly-1.5.0-6GQgazTF7VkDmpcwDjBhon" False) (C1 (MetaCons "DescribeVoicesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dvrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dvrsVoices") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Voice]))) (S1 (MetaSel (Just Symbol "_dvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

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.