| Copyright | (c) 2013-2018 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 |
Network.AWS.Polly
Contents
- Service Configuration
- Errors
- UnsupportedPlsLanguageException
- InvalidSsmlException
- InvalidSampleRateException
- MaxLexiconsNumberExceededException
- TextLengthExceededException
- MaxLexemeLengthExceededException
- InvalidLexiconException
- ServiceFailureException
- UnsupportedPlsAlphabetException
- InvalidNextTokenException
- MarksNotSupportedForFormatException
- SsmlMarksNotSupportedForTextTypeException
- LexiconSizeExceededException
- LexiconNotFoundException
- Waiters
- Operations
- Types
Description
Amazon Polly is a web service that makes it easy to synthesize speech from text.
The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain.
Synopsis
- polly :: Service
- _UnsupportedPlsLanguageException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSsmlException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSampleRateException :: AsError a => Getting (First ServiceError) a ServiceError
- _MaxLexiconsNumberExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _TextLengthExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _MaxLexemeLengthExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidLexiconException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedPlsAlphabetException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _MarksNotSupportedForFormatException :: AsError a => Getting (First ServiceError) a ServiceError
- _SsmlMarksNotSupportedForTextTypeException :: AsError a => Getting (First ServiceError) a ServiceError
- _LexiconSizeExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _LexiconNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.Polly.GetLexicon
- module Network.AWS.Polly.DescribeVoices
- module Network.AWS.Polly.ListLexicons
- module Network.AWS.Polly.SynthesizeSpeech
- module Network.AWS.Polly.PutLexicon
- module Network.AWS.Polly.DeleteLexicon
- data Gender
- data LanguageCode
- data OutputFormat
- data SpeechMarkType
- data TextType
- data VoiceId
- = Aditi
- | Amy
- | Astrid
- | Brian
- | Carla
- | Carmen
- | Celine
- | Chantal
- | Conchita
- | Cristiano
- | Dora
- | Emma
- | Enrique
- | Ewa
- | Filiz
- | Geraint
- | Giorgio
- | Gwyneth
- | Hans
- | Ines
- | Ivy
- | Jacek
- | Jan
- | Joanna
- | Joey
- | Justin
- | Karl
- | Kendra
- | Kimberly
- | Liv
- | Lotte
- | Mads
- | Maja
- | Marlene
- | Mathieu
- | Matthew
- | Maxim
- | Miguel
- | Mizuki
- | Naja
- | Nicole
- | Penelope
- | Raveena
- | Ricardo
- | Ruben
- | Russell
- | Salli
- | Seoyeon
- | Takumi
- | Tatyana
- | Vicki
- | Vitoria
- data Lexicon
- lexicon :: Lexicon
- lContent :: Lens' Lexicon (Maybe Text)
- lName :: Lens' Lexicon (Maybe Text)
- data LexiconAttributes
- lexiconAttributes :: LexiconAttributes
- laLanguageCode :: Lens' LexiconAttributes (Maybe LanguageCode)
- laSize :: Lens' LexiconAttributes (Maybe Int)
- laLexemesCount :: Lens' LexiconAttributes (Maybe Int)
- laLexiconARN :: Lens' LexiconAttributes (Maybe Text)
- laAlphabet :: Lens' LexiconAttributes (Maybe Text)
- laLastModified :: Lens' LexiconAttributes (Maybe UTCTime)
- data LexiconDescription
- lexiconDescription :: LexiconDescription
- ldAttributes :: Lens' LexiconDescription (Maybe LexiconAttributes)
- ldName :: Lens' LexiconDescription (Maybe Text)
- data Voice
- voice :: Voice
- vLanguageCode :: Lens' Voice (Maybe LanguageCode)
- vLanguageName :: Lens' Voice (Maybe Text)
- vGender :: Lens' Voice (Maybe Gender)
- vName :: Lens' Voice (Maybe Text)
- vId :: Lens' Voice (Maybe VoiceId)
Service Configuration
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Polly.
UnsupportedPlsLanguageException
_UnsupportedPlsLanguageException :: AsError a => Getting (First ServiceError) a ServiceError #
The language specified in the lexicon is unsupported. For a list of supported languages, see Lexicon Attributes .
InvalidSsmlException
_InvalidSsmlException :: AsError a => Getting (First ServiceError) a ServiceError #
The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.
InvalidSampleRateException
_InvalidSampleRateException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified sample rate is not valid.
MaxLexiconsNumberExceededException
_MaxLexiconsNumberExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
The maximum number of lexicons would be exceeded by this operation.
TextLengthExceededException
_TextLengthExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
The value of the Text parameter is longer than the accepted limits. The limit for input text is a maximum of 3000 characters total, of which no more than 1500 can be billed characters. SSML tags are not counted as billed characters.
MaxLexemeLengthExceededException
_MaxLexemeLengthExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
The maximum size of the lexeme would be exceeded by this operation.
InvalidLexiconException
_InvalidLexiconException :: AsError a => Getting (First ServiceError) a ServiceError #
Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and then try again.
ServiceFailureException
_ServiceFailureException :: AsError a => Getting (First ServiceError) a ServiceError #
An unknown condition has caused a service failure.
UnsupportedPlsAlphabetException
_UnsupportedPlsAlphabetException :: AsError a => Getting (First ServiceError) a ServiceError #
The alphabet specified by the lexicon is not a supported alphabet. Valid values are x-sampa and ipa .
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError #
The NextToken is invalid. Verify that it's spelled correctly, and then try again.
MarksNotSupportedForFormatException
_MarksNotSupportedForFormatException :: AsError a => Getting (First ServiceError) a ServiceError #
Speech marks are not supported for the OutputFormat selected. Speech marks are only available for content in json format.
SsmlMarksNotSupportedForTextTypeException
_SsmlMarksNotSupportedForTextTypeException :: AsError a => Getting (First ServiceError) a ServiceError #
SSML speech marks are not supported for plain text-type input.
LexiconSizeExceededException
_LexiconSizeExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
The maximum size of the specified lexicon would be exceeded by this operation.
LexiconNotFoundException
_LexiconNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons ) and that you spelled its name is spelled correctly. Then try again.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetLexicon
module Network.AWS.Polly.GetLexicon
DescribeVoices (Paginated)
ListLexicons
SynthesizeSpeech
PutLexicon
module Network.AWS.Polly.PutLexicon
DeleteLexicon
Types
Gender
Instances
| Bounded Gender # | |
| Enum Gender # | |
Defined in Network.AWS.Polly.Types.Sum | |
| Eq Gender # | |
| Data Gender # | |
Defined in Network.AWS.Polly.Types.Sum Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Gender -> c Gender # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Gender # toConstr :: Gender -> Constr # dataTypeOf :: Gender -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Gender) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Gender) # gmapT :: (forall b. Data b => b -> b) -> Gender -> Gender # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Gender -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Gender -> r # gmapQ :: (forall d. Data d => d -> u) -> Gender -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Gender -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Gender -> m Gender # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Gender -> m Gender # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Gender -> m Gender # | |
| Ord Gender # | |
| Read Gender # | |
| Show Gender # | |
| Generic Gender # | |
| Hashable Gender # | |
Defined in Network.AWS.Polly.Types.Sum | |
| FromJSON Gender # | |
| ToHeader Gender # | |
Defined in Network.AWS.Polly.Types.Sum Methods toHeader :: HeaderName -> Gender -> [Header] # | |
| ToQuery Gender # | |
Defined in Network.AWS.Polly.Types.Sum Methods toQuery :: Gender -> QueryString # | |
| ToByteString Gender # | |
Defined in Network.AWS.Polly.Types.Sum Methods toBS :: Gender -> ByteString # | |
| FromText Gender # | |
Defined in Network.AWS.Polly.Types.Sum | |
| ToText Gender # | |
Defined in Network.AWS.Polly.Types.Sum | |
| NFData Gender # | |
Defined in Network.AWS.Polly.Types.Sum | |
| type Rep Gender # | |
LanguageCode
data LanguageCode #
Constructors
| CyGb | |
| DaDk | |
| DeDe | |
| EnAu | |
| EnGb | |
| EnGbWls | |
| EnIn | |
| EnUs | |
| EsEs | |
| EsUs | |
| FrCa | |
| FrFr | |
| IsIs | |
| ItIt | |
| JaJp | |
| KoKr | |
| NbNo | |
| NlNl | |
| PlPl | |
| PtBr | |
| PtPt | |
| RoRo | |
| RuRu | |
| SvSe | |
| TrTr |
Instances
OutputFormat
data OutputFormat #
Instances
SpeechMarkType
data SpeechMarkType #
Instances
TextType
Instances
VoiceId
Constructors
Instances
Lexicon
Provides lexicon name and lexicon content in string format. For more information, see Pronunciation Lexicon Specification (PLS) Version 1.0 .
See: lexicon smart constructor.
Instances
| Eq Lexicon # | |
| Data Lexicon # | |
Defined in Network.AWS.Polly.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Lexicon -> c Lexicon # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Lexicon # toConstr :: Lexicon -> Constr # dataTypeOf :: Lexicon -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Lexicon) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Lexicon) # gmapT :: (forall b. Data b => b -> b) -> Lexicon -> Lexicon # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Lexicon -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Lexicon -> r # gmapQ :: (forall d. Data d => d -> u) -> Lexicon -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Lexicon -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Lexicon -> m Lexicon # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Lexicon -> m Lexicon # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Lexicon -> m Lexicon # | |
| Show Lexicon # | |
| Generic Lexicon # | |
| Hashable Lexicon # | |
Defined in Network.AWS.Polly.Types.Product | |
| FromJSON Lexicon # | |
| NFData Lexicon # | |
Defined in Network.AWS.Polly.Types.Product | |
| type Rep Lexicon # | |
Defined in Network.AWS.Polly.Types.Product type Rep Lexicon = D1 (MetaData "Lexicon" "Network.AWS.Polly.Types.Product" "amazonka-polly-1.6.1-2IwsfrEVc5c8vKHoB26sNU" False) (C1 (MetaCons "Lexicon'" PrefixI True) (S1 (MetaSel (Just "_lContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) | |
lContent :: Lens' Lexicon (Maybe Text) #
Lexicon content in string format. The content of a lexicon must be in PLS format.
LexiconAttributes
data LexiconAttributes #
Contains metadata describing the lexicon such as the number of lexemes, language code, and so on. For more information, see Managing Lexicons .
See: lexiconAttributes smart constructor.
Instances
lexiconAttributes :: LexiconAttributes #
Creates a value of LexiconAttributes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
laLanguageCode- Language code that the lexicon applies to. A lexicon with a language code such as "en" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.laSize- Total size of the lexicon, in characters.laLexemesCount- Number of lexemes in the lexicon.laLexiconARN- Amazon Resource Name (ARN) of the lexicon.laAlphabet- Phonetic alphabet used in the lexicon. Valid values areipaandx-sampa.laLastModified- Date lexicon was last modified (a timestamp value).
laLanguageCode :: Lens' LexiconAttributes (Maybe LanguageCode) #
Language code that the lexicon applies to. A lexicon with a language code such as "en" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.
laLexemesCount :: Lens' LexiconAttributes (Maybe Int) #
Number of lexemes in the lexicon.
laLexiconARN :: Lens' LexiconAttributes (Maybe Text) #
Amazon Resource Name (ARN) of the lexicon.
laAlphabet :: Lens' LexiconAttributes (Maybe Text) #
Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa .
laLastModified :: Lens' LexiconAttributes (Maybe UTCTime) #
Date lexicon was last modified (a timestamp value).
LexiconDescription
data LexiconDescription #
Describes the content of the lexicon.
See: lexiconDescription smart constructor.
Instances
lexiconDescription :: LexiconDescription #
Creates a value of LexiconDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldAttributes- Provides lexicon metadata.ldName- Name of the lexicon.
ldAttributes :: Lens' LexiconDescription (Maybe LexiconAttributes) #
Provides lexicon metadata.
Voice
Description of the voice.
See: voice smart constructor.
Instances
| Eq Voice # | |
| Data Voice # | |
Defined in Network.AWS.Polly.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Voice -> c Voice # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Voice # dataTypeOf :: Voice -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Voice) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Voice) # gmapT :: (forall b. Data b => b -> b) -> Voice -> Voice # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Voice -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Voice -> r # gmapQ :: (forall d. Data d => d -> u) -> Voice -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Voice -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Voice -> m Voice # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Voice -> m Voice # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Voice -> m Voice # | |
| Read Voice # | |
| Show Voice # | |
| Generic Voice # | |
| Hashable Voice # | |
Defined in Network.AWS.Polly.Types.Product | |
| FromJSON Voice # | |
| NFData Voice # | |
Defined in Network.AWS.Polly.Types.Product | |
| type Rep Voice # | |
Defined in Network.AWS.Polly.Types.Product type Rep Voice = D1 (MetaData "Voice" "Network.AWS.Polly.Types.Product" "amazonka-polly-1.6.1-2IwsfrEVc5c8vKHoB26sNU" False) (C1 (MetaCons "Voice'" PrefixI True) ((S1 (MetaSel (Just "_vLanguageCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: S1 (MetaSel (Just "_vLanguageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_vGender") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Gender)) :*: (S1 (MetaSel (Just "_vName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_vId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VoiceId)))))) | |
Creates a value of Voice with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vLanguageCode- Language code of the voice.vLanguageName- Human readable name of the language in English.vGender- Gender of the voice.vName- Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.vId- Amazon Polly assigned voice ID. This is the ID that you specify when calling theSynthesizeSpeechoperation.
vLanguageCode :: Lens' Voice (Maybe LanguageCode) #
Language code of the voice.