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

Amazonka.Polly.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2016-06-10 of the Amazon Polly SDK configuration.

Errors

_InvalidSnsTopicArnException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try again.

_UnsupportedPlsLanguageException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The language specified in the lexicon is unsupported. For a list of supported languages, see Lexicon Attributes.

_InvalidSsmlException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.

_InvalidSampleRateException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified sample rate is not valid.

_EngineNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

This engine is not compatible with the voice that you have designated. Choose a new voice that is compatible with the engine or change the engine and restart the operation.

_MaxLexiconsNumberExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The maximum number of lexicons would be exceeded by this operation.

_TextLengthExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The value of the "Text" parameter is longer than the accepted limits. For the SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not counted as billed characters.

_MaxLexemeLengthExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The maximum size of the lexeme would be exceeded by this operation.

_InvalidTaskIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The provided Task ID is not valid. Please provide a valid Task ID and try again.

_InvalidLexiconException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and then try again.

_ServiceFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #

An unknown condition has caused a service failure.

_UnsupportedPlsAlphabetException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The alphabet specified by the lexicon is not a supported alphabet. Valid values are x-sampa and ipa.

_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The NextToken is invalid. Verify that it's spelled correctly, and then try again.

_MarksNotSupportedForFormatException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Speech marks are not supported for the OutputFormat selected. Speech marks are only available for content in json format.

_SynthesisTaskNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The Speech Synthesis task with requested Task ID cannot be found.

_SsmlMarksNotSupportedForTextTypeException :: AsError a => Getting (First ServiceError) a ServiceError Source #

SSML speech marks are not supported for plain text-type input.

_InvalidS3BucketException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket naming requirements and try again.

_LexiconSizeExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The maximum size of the specified lexicon would be exceeded by this operation.

_LanguageNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The language specified is not currently supported by Amazon Polly in this capacity.

_LexiconNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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.

_InvalidS3KeyException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key name.

Engine

newtype Engine Source #

Constructors

Engine' 

Fields

Bundled Patterns

pattern Engine_Neural :: Engine 
pattern Engine_Standard :: Engine 

Instances

Instances details
Eq Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

Methods

(==) :: Engine -> Engine -> Bool #

(/=) :: Engine -> Engine -> Bool #

Ord Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

Read Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

Show Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

Generic Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

Associated Types

type Rep Engine :: Type -> Type #

Methods

from :: Engine -> Rep Engine x #

to :: Rep Engine x -> Engine #

NFData Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

Methods

rnf :: Engine -> () #

Hashable Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

Methods

hashWithSalt :: Int -> Engine -> Int #

hash :: Engine -> Int #

ToJSON Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

ToJSONKey Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

FromJSON Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

FromJSONKey Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

ToLog Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

ToHeader Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

Methods

toHeader :: HeaderName -> Engine -> [Header] #

ToQuery Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

FromXML Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

ToXML Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

Methods

toXML :: Engine -> XML #

ToByteString Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

Methods

toBS :: Engine -> ByteString #

FromText Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

ToText Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

Methods

toText :: Engine -> Text #

type Rep Engine Source # 
Instance details

Defined in Amazonka.Polly.Types.Engine

type Rep Engine = D1 ('MetaData "Engine" "Amazonka.Polly.Types.Engine" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'True) (C1 ('MetaCons "Engine'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEngine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Gender

newtype Gender Source #

Constructors

Gender' 

Fields

Bundled Patterns

pattern Gender_Female :: Gender 
pattern Gender_Male :: Gender 

Instances

Instances details
Eq Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

Methods

(==) :: Gender -> Gender -> Bool #

(/=) :: Gender -> Gender -> Bool #

Ord Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

Read Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

Show Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

Generic Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

Associated Types

type Rep Gender :: Type -> Type #

Methods

from :: Gender -> Rep Gender x #

to :: Rep Gender x -> Gender #

NFData Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

Methods

rnf :: Gender -> () #

Hashable Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

Methods

hashWithSalt :: Int -> Gender -> Int #

hash :: Gender -> Int #

ToJSON Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

ToJSONKey Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

FromJSON Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

FromJSONKey Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

ToLog Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

ToHeader Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

Methods

toHeader :: HeaderName -> Gender -> [Header] #

ToQuery Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

FromXML Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

ToXML Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

Methods

toXML :: Gender -> XML #

ToByteString Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

Methods

toBS :: Gender -> ByteString #

FromText Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

ToText Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

Methods

toText :: Gender -> Text #

type Rep Gender Source # 
Instance details

Defined in Amazonka.Polly.Types.Gender

type Rep Gender = D1 ('MetaData "Gender" "Amazonka.Polly.Types.Gender" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'True) (C1 ('MetaCons "Gender'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromGender") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

LanguageCode

newtype LanguageCode Source #

Constructors

LanguageCode' 

Instances

Instances details
Eq LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

Ord LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

Read LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

Show LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

Generic LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

Associated Types

type Rep LanguageCode :: Type -> Type #

NFData LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

Methods

rnf :: LanguageCode -> () #

Hashable LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

ToJSON LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

ToJSONKey LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

FromJSON LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

FromJSONKey LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

ToLog LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

ToHeader LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

ToQuery LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

FromXML LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

ToXML LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

Methods

toXML :: LanguageCode -> XML #

ToByteString LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

FromText LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

ToText LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

Methods

toText :: LanguageCode -> Text #

type Rep LanguageCode Source # 
Instance details

Defined in Amazonka.Polly.Types.LanguageCode

type Rep LanguageCode = D1 ('MetaData "LanguageCode" "Amazonka.Polly.Types.LanguageCode" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'True) (C1 ('MetaCons "LanguageCode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

OutputFormat

newtype OutputFormat Source #

Constructors

OutputFormat' 

Instances

Instances details
Eq OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

Ord OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

Read OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

Show OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

Generic OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

Associated Types

type Rep OutputFormat :: Type -> Type #

NFData OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

Methods

rnf :: OutputFormat -> () #

Hashable OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

ToJSON OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

ToJSONKey OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

FromJSON OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

FromJSONKey OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

ToLog OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

ToHeader OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

ToQuery OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

FromXML OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

ToXML OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

Methods

toXML :: OutputFormat -> XML #

ToByteString OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

FromText OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

ToText OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

Methods

toText :: OutputFormat -> Text #

type Rep OutputFormat Source # 
Instance details

Defined in Amazonka.Polly.Types.OutputFormat

type Rep OutputFormat = D1 ('MetaData "OutputFormat" "Amazonka.Polly.Types.OutputFormat" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'True) (C1 ('MetaCons "OutputFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOutputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SpeechMarkType

newtype SpeechMarkType Source #

Constructors

SpeechMarkType' 

Instances

Instances details
Eq SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

Ord SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

Read SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

Show SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

Generic SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

Associated Types

type Rep SpeechMarkType :: Type -> Type #

NFData SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

Methods

rnf :: SpeechMarkType -> () #

Hashable SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

ToJSON SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

ToJSONKey SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

FromJSON SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

FromJSONKey SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

ToLog SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

ToHeader SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

ToQuery SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

FromXML SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

ToXML SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

Methods

toXML :: SpeechMarkType -> XML #

ToByteString SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

FromText SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

ToText SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

type Rep SpeechMarkType Source # 
Instance details

Defined in Amazonka.Polly.Types.SpeechMarkType

type Rep SpeechMarkType = D1 ('MetaData "SpeechMarkType" "Amazonka.Polly.Types.SpeechMarkType" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'True) (C1 ('MetaCons "SpeechMarkType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSpeechMarkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TaskStatus

newtype TaskStatus Source #

Constructors

TaskStatus' 

Fields

Instances

Instances details
Eq TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

Ord TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

Read TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

Show TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

Generic TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

Associated Types

type Rep TaskStatus :: Type -> Type #

NFData TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

Methods

rnf :: TaskStatus -> () #

Hashable TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

ToJSON TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

ToJSONKey TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

FromJSON TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

FromJSONKey TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

ToLog TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

ToHeader TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

ToQuery TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

FromXML TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

ToXML TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

Methods

toXML :: TaskStatus -> XML #

ToByteString TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

FromText TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

ToText TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

Methods

toText :: TaskStatus -> Text #

type Rep TaskStatus Source # 
Instance details

Defined in Amazonka.Polly.Types.TaskStatus

type Rep TaskStatus = D1 ('MetaData "TaskStatus" "Amazonka.Polly.Types.TaskStatus" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'True) (C1 ('MetaCons "TaskStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTaskStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TextType

newtype TextType Source #

Constructors

TextType' 

Fields

Bundled Patterns

pattern TextType_Ssml :: TextType 
pattern TextType_Text :: TextType 

Instances

Instances details
Eq TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

Ord TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

Read TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

Show TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

Generic TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

Associated Types

type Rep TextType :: Type -> Type #

Methods

from :: TextType -> Rep TextType x #

to :: Rep TextType x -> TextType #

NFData TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

Methods

rnf :: TextType -> () #

Hashable TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

Methods

hashWithSalt :: Int -> TextType -> Int #

hash :: TextType -> Int #

ToJSON TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

ToJSONKey TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

FromJSON TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

FromJSONKey TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

ToLog TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

ToHeader TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

Methods

toHeader :: HeaderName -> TextType -> [Header] #

ToQuery TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

FromXML TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

ToXML TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

Methods

toXML :: TextType -> XML #

ToByteString TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

Methods

toBS :: TextType -> ByteString #

FromText TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

ToText TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

Methods

toText :: TextType -> Text #

type Rep TextType Source # 
Instance details

Defined in Amazonka.Polly.Types.TextType

type Rep TextType = D1 ('MetaData "TextType" "Amazonka.Polly.Types.TextType" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'True) (C1 ('MetaCons "TextType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTextType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

VoiceId

newtype VoiceId Source #

Constructors

VoiceId' 

Fields

Bundled Patterns

pattern VoiceId_Aditi :: VoiceId 
pattern VoiceId_Amy :: VoiceId 
pattern VoiceId_Aria :: VoiceId 
pattern VoiceId_Astrid :: VoiceId 
pattern VoiceId_Ayanda :: VoiceId 
pattern VoiceId_Bianca :: VoiceId 
pattern VoiceId_Brian :: VoiceId 
pattern VoiceId_Camila :: VoiceId 
pattern VoiceId_Carla :: VoiceId 
pattern VoiceId_Carmen :: VoiceId 
pattern VoiceId_Celine :: VoiceId 
pattern VoiceId_Chantal :: VoiceId 
pattern VoiceId_Conchita :: VoiceId 
pattern VoiceId_Cristiano :: VoiceId 
pattern VoiceId_Dora :: VoiceId 
pattern VoiceId_Emma :: VoiceId 
pattern VoiceId_Enrique :: VoiceId 
pattern VoiceId_Ewa :: VoiceId 
pattern VoiceId_Filiz :: VoiceId 
pattern VoiceId_Gabrielle :: VoiceId 
pattern VoiceId_Geraint :: VoiceId 
pattern VoiceId_Giorgio :: VoiceId 
pattern VoiceId_Gwyneth :: VoiceId 
pattern VoiceId_Hans :: VoiceId 
pattern VoiceId_Ines :: VoiceId 
pattern VoiceId_Ivy :: VoiceId 
pattern VoiceId_Jacek :: VoiceId 
pattern VoiceId_Jan :: VoiceId 
pattern VoiceId_Joanna :: VoiceId 
pattern VoiceId_Joey :: VoiceId 
pattern VoiceId_Justin :: VoiceId 
pattern VoiceId_Karl :: VoiceId 
pattern VoiceId_Kendra :: VoiceId 
pattern VoiceId_Kevin :: VoiceId 
pattern VoiceId_Kimberly :: VoiceId 
pattern VoiceId_Lea :: VoiceId 
pattern VoiceId_Liv :: VoiceId 
pattern VoiceId_Lotte :: VoiceId 
pattern VoiceId_Lucia :: VoiceId 
pattern VoiceId_Lupe :: VoiceId 
pattern VoiceId_Mads :: VoiceId 
pattern VoiceId_Maja :: VoiceId 
pattern VoiceId_Marlene :: VoiceId 
pattern VoiceId_Mathieu :: VoiceId 
pattern VoiceId_Matthew :: VoiceId 
pattern VoiceId_Maxim :: VoiceId 
pattern VoiceId_Mia :: VoiceId 
pattern VoiceId_Miguel :: VoiceId 
pattern VoiceId_Mizuki :: VoiceId 
pattern VoiceId_Naja :: VoiceId 
pattern VoiceId_Nicole :: VoiceId 
pattern VoiceId_Olivia :: VoiceId 
pattern VoiceId_Penelope :: VoiceId 
pattern VoiceId_Raveena :: VoiceId 
pattern VoiceId_Ricardo :: VoiceId 
pattern VoiceId_Ruben :: VoiceId 
pattern VoiceId_Russell :: VoiceId 
pattern VoiceId_Salli :: VoiceId 
pattern VoiceId_Seoyeon :: VoiceId 
pattern VoiceId_Takumi :: VoiceId 
pattern VoiceId_Tatyana :: VoiceId 
pattern VoiceId_Vicki :: VoiceId 
pattern VoiceId_Vitoria :: VoiceId 
pattern VoiceId_Zeina :: VoiceId 
pattern VoiceId_Zhiyu :: VoiceId 

Instances

Instances details
Eq VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

Methods

(==) :: VoiceId -> VoiceId -> Bool #

(/=) :: VoiceId -> VoiceId -> Bool #

Ord VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

Read VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

Show VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

Generic VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

Associated Types

type Rep VoiceId :: Type -> Type #

Methods

from :: VoiceId -> Rep VoiceId x #

to :: Rep VoiceId x -> VoiceId #

NFData VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

Methods

rnf :: VoiceId -> () #

Hashable VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

Methods

hashWithSalt :: Int -> VoiceId -> Int #

hash :: VoiceId -> Int #

ToJSON VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

ToJSONKey VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

FromJSON VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

FromJSONKey VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

ToLog VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

ToHeader VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

Methods

toHeader :: HeaderName -> VoiceId -> [Header] #

ToQuery VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

FromXML VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

ToXML VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

Methods

toXML :: VoiceId -> XML #

ToByteString VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

Methods

toBS :: VoiceId -> ByteString #

FromText VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

ToText VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

Methods

toText :: VoiceId -> Text #

type Rep VoiceId Source # 
Instance details

Defined in Amazonka.Polly.Types.VoiceId

type Rep VoiceId = D1 ('MetaData "VoiceId" "Amazonka.Polly.Types.VoiceId" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'True) (C1 ('MetaCons "VoiceId'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromVoiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Lexicon

data Lexicon Source #

Provides lexicon name and lexicon content in string format. For more information, see Pronunciation Lexicon Specification (PLS) Version 1.0.

See: newLexicon smart constructor.

Constructors

Lexicon' 

Fields

Instances

Instances details
Eq Lexicon Source # 
Instance details

Defined in Amazonka.Polly.Types.Lexicon

Methods

(==) :: Lexicon -> Lexicon -> Bool #

(/=) :: Lexicon -> Lexicon -> Bool #

Show Lexicon Source # 
Instance details

Defined in Amazonka.Polly.Types.Lexicon

Generic Lexicon Source # 
Instance details

Defined in Amazonka.Polly.Types.Lexicon

Associated Types

type Rep Lexicon :: Type -> Type #

Methods

from :: Lexicon -> Rep Lexicon x #

to :: Rep Lexicon x -> Lexicon #

NFData Lexicon Source # 
Instance details

Defined in Amazonka.Polly.Types.Lexicon

Methods

rnf :: Lexicon -> () #

Hashable Lexicon Source # 
Instance details

Defined in Amazonka.Polly.Types.Lexicon

Methods

hashWithSalt :: Int -> Lexicon -> Int #

hash :: Lexicon -> Int #

FromJSON Lexicon Source # 
Instance details

Defined in Amazonka.Polly.Types.Lexicon

type Rep Lexicon Source # 
Instance details

Defined in Amazonka.Polly.Types.Lexicon

type Rep Lexicon = D1 ('MetaData "Lexicon" "Amazonka.Polly.Types.Lexicon" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'False) (C1 ('MetaCons "Lexicon'" 'PrefixI 'True) (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newLexicon :: Lexicon Source #

Create a value of Lexicon 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:content:Lexicon', lexicon_content - Lexicon content in string format. The content of a lexicon must be in PLS format.

$sel:name:Lexicon', lexicon_name - Name of the lexicon.

lexicon_content :: Lens' Lexicon (Maybe Text) Source #

Lexicon content in string format. The content of a lexicon must be in PLS format.

lexicon_name :: Lens' Lexicon (Maybe Text) Source #

Name of the lexicon.

LexiconAttributes

data LexiconAttributes Source #

Contains metadata describing the lexicon such as the number of lexemes, language code, and so on. For more information, see Managing Lexicons.

See: newLexiconAttributes smart constructor.

Constructors

LexiconAttributes' 

Fields

Instances

Instances details
Eq LexiconAttributes Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconAttributes

Read LexiconAttributes Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconAttributes

Show LexiconAttributes Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconAttributes

Generic LexiconAttributes Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconAttributes

Associated Types

type Rep LexiconAttributes :: Type -> Type #

NFData LexiconAttributes Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconAttributes

Methods

rnf :: LexiconAttributes -> () #

Hashable LexiconAttributes Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconAttributes

FromJSON LexiconAttributes Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconAttributes

type Rep LexiconAttributes Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconAttributes

type Rep LexiconAttributes = D1 ('MetaData "LexiconAttributes" "Amazonka.Polly.Types.LexiconAttributes" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'False) (C1 ('MetaCons "LexiconAttributes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "lexemesCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "lexiconArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "alphabet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModified") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newLexiconAttributes :: LexiconAttributes Source #

Create a value of LexiconAttributes 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:LexiconAttributes', lexiconAttributes_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.

$sel:size:LexiconAttributes', lexiconAttributes_size - Total size of the lexicon, in characters.

$sel:lexemesCount:LexiconAttributes', lexiconAttributes_lexemesCount - Number of lexemes in the lexicon.

$sel:lexiconArn:LexiconAttributes', lexiconAttributes_lexiconArn - Amazon Resource Name (ARN) of the lexicon.

$sel:alphabet:LexiconAttributes', lexiconAttributes_alphabet - Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.

$sel:lastModified:LexiconAttributes', lexiconAttributes_lastModified - Date lexicon was last modified (a timestamp value).

lexiconAttributes_languageCode :: Lens' LexiconAttributes (Maybe LanguageCode) Source #

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.

lexiconAttributes_size :: Lens' LexiconAttributes (Maybe Int) Source #

Total size of the lexicon, in characters.

lexiconAttributes_lexiconArn :: Lens' LexiconAttributes (Maybe Text) Source #

Amazon Resource Name (ARN) of the lexicon.

lexiconAttributes_alphabet :: Lens' LexiconAttributes (Maybe Text) Source #

Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.

lexiconAttributes_lastModified :: Lens' LexiconAttributes (Maybe UTCTime) Source #

Date lexicon was last modified (a timestamp value).

LexiconDescription

data LexiconDescription Source #

Describes the content of the lexicon.

See: newLexiconDescription smart constructor.

Constructors

LexiconDescription' 

Fields

Instances

Instances details
Eq LexiconDescription Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconDescription

Read LexiconDescription Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconDescription

Show LexiconDescription Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconDescription

Generic LexiconDescription Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconDescription

Associated Types

type Rep LexiconDescription :: Type -> Type #

NFData LexiconDescription Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconDescription

Methods

rnf :: LexiconDescription -> () #

Hashable LexiconDescription Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconDescription

FromJSON LexiconDescription Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconDescription

type Rep LexiconDescription Source # 
Instance details

Defined in Amazonka.Polly.Types.LexiconDescription

type Rep LexiconDescription = D1 ('MetaData "LexiconDescription" "Amazonka.Polly.Types.LexiconDescription" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'False) (C1 ('MetaCons "LexiconDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LexiconAttributes)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newLexiconDescription :: LexiconDescription Source #

Create a value of LexiconDescription 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:attributes:LexiconDescription', lexiconDescription_attributes - Provides lexicon metadata.

$sel:name:LexiconDescription', lexiconDescription_name - Name of the lexicon.

SynthesisTask

data SynthesisTask Source #

SynthesisTask object that provides information about a speech synthesis task.

See: newSynthesisTask smart constructor.

Constructors

SynthesisTask' 

Fields

  • creationTime :: Maybe POSIX

    Timestamp for the time the synthesis task was started.

  • languageCode :: Maybe LanguageCode

    Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

  • snsTopicArn :: Maybe Text

    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

  • taskStatusReason :: Maybe Text

    Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

  • taskId :: Maybe Text

    The Amazon Polly generated identifier for a speech synthesis task.

  • requestCharacters :: Maybe Int

    Number of billable characters synthesized.

  • engine :: Maybe Engine

    Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

  • speechMarkTypes :: Maybe [SpeechMarkType]

    The type of speech marks returned for the input text.

  • sampleRate :: Maybe Text

    The audio frequency specified in Hz.

    The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

    Valid values for pcm are "8000" and "16000" The default value is "16000".

  • outputFormat :: Maybe OutputFormat

    The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

  • textType :: Maybe TextType

    Specifies whether the input text is plain text or SSML. The default value is plain text.

  • voiceId :: Maybe VoiceId

    Voice ID to use for the synthesis.

  • lexiconNames :: Maybe [Text]

    List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

  • taskStatus :: Maybe TaskStatus

    Current status of the individual speech synthesis task.

  • outputUri :: Maybe Text

    Pathway for the output speech file.

Instances

Instances details
Eq SynthesisTask Source # 
Instance details

Defined in Amazonka.Polly.Types.SynthesisTask

Read SynthesisTask Source # 
Instance details

Defined in Amazonka.Polly.Types.SynthesisTask

Show SynthesisTask Source # 
Instance details

Defined in Amazonka.Polly.Types.SynthesisTask

Generic SynthesisTask Source # 
Instance details

Defined in Amazonka.Polly.Types.SynthesisTask

Associated Types

type Rep SynthesisTask :: Type -> Type #

NFData SynthesisTask Source # 
Instance details

Defined in Amazonka.Polly.Types.SynthesisTask

Methods

rnf :: SynthesisTask -> () #

Hashable SynthesisTask Source # 
Instance details

Defined in Amazonka.Polly.Types.SynthesisTask

FromJSON SynthesisTask Source # 
Instance details

Defined in Amazonka.Polly.Types.SynthesisTask

type Rep SynthesisTask Source # 
Instance details

Defined in Amazonka.Polly.Types.SynthesisTask

type Rep SynthesisTask = D1 ('MetaData "SynthesisTask" "Amazonka.Polly.Types.SynthesisTask" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'False) (C1 ('MetaCons "SynthesisTask'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "taskStatusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "requestCharacters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Engine))))) :*: (((S1 ('MetaSel ('Just "speechMarkTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SpeechMarkType])) :*: S1 ('MetaSel ('Just "sampleRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "outputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputFormat)) :*: S1 ('MetaSel ('Just "textType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextType)))) :*: ((S1 ('MetaSel ('Just "voiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VoiceId)) :*: S1 ('MetaSel ('Just "lexiconNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "taskStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskStatus)) :*: S1 ('MetaSel ('Just "outputUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newSynthesisTask :: SynthesisTask Source #

Create a value of SynthesisTask 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:creationTime:SynthesisTask', synthesisTask_creationTime - Timestamp for the time the synthesis task was started.

$sel:languageCode:SynthesisTask', synthesisTask_languageCode - Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

$sel:snsTopicArn:SynthesisTask', synthesisTask_snsTopicArn - ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

$sel:taskStatusReason:SynthesisTask', synthesisTask_taskStatusReason - Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

$sel:taskId:SynthesisTask', synthesisTask_taskId - The Amazon Polly generated identifier for a speech synthesis task.

$sel:requestCharacters:SynthesisTask', synthesisTask_requestCharacters - Number of billable characters synthesized.

$sel:engine:SynthesisTask', synthesisTask_engine - Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

$sel:speechMarkTypes:SynthesisTask', synthesisTask_speechMarkTypes - The type of speech marks returned for the input text.

$sel:sampleRate:SynthesisTask', synthesisTask_sampleRate - The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

$sel:outputFormat:SynthesisTask', synthesisTask_outputFormat - The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

$sel:textType:SynthesisTask', synthesisTask_textType - Specifies whether the input text is plain text or SSML. The default value is plain text.

$sel:voiceId:SynthesisTask', synthesisTask_voiceId - Voice ID to use for the synthesis.

$sel:lexiconNames:SynthesisTask', synthesisTask_lexiconNames - List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

$sel:taskStatus:SynthesisTask', synthesisTask_taskStatus - Current status of the individual speech synthesis task.

$sel:outputUri:SynthesisTask', synthesisTask_outputUri - Pathway for the output speech file.

synthesisTask_creationTime :: Lens' SynthesisTask (Maybe UTCTime) Source #

Timestamp for the time the synthesis task was started.

synthesisTask_languageCode :: Lens' SynthesisTask (Maybe LanguageCode) Source #

Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

synthesisTask_snsTopicArn :: Lens' SynthesisTask (Maybe Text) Source #

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

synthesisTask_taskStatusReason :: Lens' SynthesisTask (Maybe Text) Source #

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

synthesisTask_taskId :: Lens' SynthesisTask (Maybe Text) Source #

The Amazon Polly generated identifier for a speech synthesis task.

synthesisTask_requestCharacters :: Lens' SynthesisTask (Maybe Int) Source #

Number of billable characters synthesized.

synthesisTask_engine :: Lens' SynthesisTask (Maybe Engine) Source #

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

synthesisTask_speechMarkTypes :: Lens' SynthesisTask (Maybe [SpeechMarkType]) Source #

The type of speech marks returned for the input text.

synthesisTask_sampleRate :: Lens' SynthesisTask (Maybe Text) Source #

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

synthesisTask_outputFormat :: Lens' SynthesisTask (Maybe OutputFormat) Source #

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

synthesisTask_textType :: Lens' SynthesisTask (Maybe TextType) Source #

Specifies whether the input text is plain text or SSML. The default value is plain text.

synthesisTask_voiceId :: Lens' SynthesisTask (Maybe VoiceId) Source #

Voice ID to use for the synthesis.

synthesisTask_lexiconNames :: Lens' SynthesisTask (Maybe [Text]) Source #

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

synthesisTask_taskStatus :: Lens' SynthesisTask (Maybe TaskStatus) Source #

Current status of the individual speech synthesis task.

synthesisTask_outputUri :: Lens' SynthesisTask (Maybe Text) Source #

Pathway for the output speech file.

Voice

data Voice Source #

Description of the voice.

See: newVoice smart constructor.

Constructors

Voice' 

Fields

  • languageCode :: Maybe LanguageCode

    Language code of the voice.

  • languageName :: Maybe Text

    Human readable name of the language in English.

  • gender :: Maybe Gender

    Gender of the voice.

  • name :: Maybe Text

    Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

  • id :: Maybe VoiceId

    Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

  • additionalLanguageCodes :: Maybe [LanguageCode]

    Additional codes for languages available for the specified voice in addition to its default language.

    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

  • supportedEngines :: Maybe [Engine]

    Specifies which engines (standard or neural) that are supported by a given voice.

Instances

Instances details
Eq Voice Source # 
Instance details

Defined in Amazonka.Polly.Types.Voice

Methods

(==) :: Voice -> Voice -> Bool #

(/=) :: Voice -> Voice -> Bool #

Read Voice Source # 
Instance details

Defined in Amazonka.Polly.Types.Voice

Show Voice Source # 
Instance details

Defined in Amazonka.Polly.Types.Voice

Methods

showsPrec :: Int -> Voice -> ShowS #

show :: Voice -> String #

showList :: [Voice] -> ShowS #

Generic Voice Source # 
Instance details

Defined in Amazonka.Polly.Types.Voice

Associated Types

type Rep Voice :: Type -> Type #

Methods

from :: Voice -> Rep Voice x #

to :: Rep Voice x -> Voice #

NFData Voice Source # 
Instance details

Defined in Amazonka.Polly.Types.Voice

Methods

rnf :: Voice -> () #

Hashable Voice Source # 
Instance details

Defined in Amazonka.Polly.Types.Voice

Methods

hashWithSalt :: Int -> Voice -> Int #

hash :: Voice -> Int #

FromJSON Voice Source # 
Instance details

Defined in Amazonka.Polly.Types.Voice

type Rep Voice Source # 
Instance details

Defined in Amazonka.Polly.Types.Voice

newVoice :: Voice Source #

Create a value of Voice 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:Voice', voice_languageCode - Language code of the voice.

$sel:languageName:Voice', voice_languageName - Human readable name of the language in English.

$sel:gender:Voice', voice_gender - Gender of the voice.

$sel:name:Voice', voice_name - Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

$sel:id:Voice', voice_id - Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

$sel:additionalLanguageCodes:Voice', voice_additionalLanguageCodes - Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

$sel:supportedEngines:Voice', voice_supportedEngines - Specifies which engines (standard or neural) that are supported by a given voice.

voice_languageCode :: Lens' Voice (Maybe LanguageCode) Source #

Language code of the voice.

voice_languageName :: Lens' Voice (Maybe Text) Source #

Human readable name of the language in English.

voice_gender :: Lens' Voice (Maybe Gender) Source #

Gender of the voice.

voice_name :: Lens' Voice (Maybe Text) Source #

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

voice_id :: Lens' Voice (Maybe VoiceId) Source #

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

voice_additionalLanguageCodes :: Lens' Voice (Maybe [LanguageCode]) Source #

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

voice_supportedEngines :: Lens' Voice (Maybe [Engine]) Source #

Specifies which engines (standard or neural) that are supported by a given voice.