@datafire/amazonaws_polly
Client library for Amazon Polly
Installation and Usage
npm install --save @datafire/amazonaws_polly
let amazonaws_polly = require('@datafire/amazonaws_polly').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_polly.ListLexicons({}).then(data => {
console.log(data);
});
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.
Actions
ListLexicons
amazonaws_polly.ListLexicons({}, context)
Input
- input
object
Output
- output ListLexiconsOutput
DeleteLexicon
amazonaws_polly.DeleteLexicon({
"LexiconName": ""
}, context)
Input
- input
object
- LexiconName required
string
- LexiconName required
Output
- output DeleteLexiconOutput
GetLexicon
amazonaws_polly.GetLexicon({
"LexiconName": ""
}, context)
Input
- input
object
- LexiconName required
string
- LexiconName required
Output
- output GetLexiconOutput
PutLexicon
amazonaws_polly.PutLexicon({
"LexiconName": "",
"Content": ""
}, context)
Input
- input
object
- LexiconName required
string
- Content required LexiconContent
- LexiconName required
Output
- output PutLexiconOutput
SynthesizeSpeech
amazonaws_polly.SynthesizeSpeech({
"OutputFormat": "",
"Text": "",
"VoiceId": ""
}, context)
Input
- input
object
- LexiconNames LexiconNameList
- OutputFormat required OutputFormat
- SampleRate SampleRate
- SpeechMarkTypes SpeechMarkTypeList
- Text required Text
- TextType TextType
- VoiceId required VoiceId
Output
- output SynthesizeSpeechOutput
DescribeVoices
amazonaws_polly.DescribeVoices({}, context)
Input
- input
object
Output
- output DescribeVoicesOutput
Definitions
Alphabet
- Alphabet
string
AudioStream
- AudioStream
string
ContentType
- ContentType
string
DeleteLexiconInput
- DeleteLexiconInput
object
DeleteLexiconOutput
- DeleteLexiconOutput
object
DescribeVoicesInput
- DescribeVoicesInput
object
DescribeVoicesOutput
ErrorMessage
- ErrorMessage
string
Gender
- Gender
string
(values: Female, Male)
GetLexiconInput
- GetLexiconInput
object
GetLexiconOutput
- GetLexiconOutput
object
- Lexicon Lexicon
- LexiconAttributes LexiconAttributes
InvalidLexiconException
- InvalidLexiconException
object
: Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and then try again.- message ErrorMessage
InvalidNextTokenException
- InvalidNextTokenException
object
: The NextToken is invalid. Verify that it's spelled correctly, and then try again.- message ErrorMessage
InvalidSampleRateException
- InvalidSampleRateException
object
: The specified sample rate is not valid.- message ErrorMessage
InvalidSsmlException
- InvalidSsmlException
object
: The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.- message ErrorMessage
LanguageCode
- LanguageCode
string
(values: cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-US, fr-CA, fr-FR, is-IS, it-IT, ko-KR, ja-JP, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR)
LanguageName
- LanguageName
string
LastModified
- LastModified
string
LexemesCount
- LexemesCount
integer
Lexicon
- Lexicon
object
: Provides lexicon name and lexicon content in string format. For more information, see Pronunciation Lexicon Specification (PLS) Version 1.0.- Content LexiconContent
- Name LexiconName
LexiconArn
- LexiconArn
string
LexiconAttributes
- LexiconAttributes
object
: Contains metadata describing the lexicon such as the number of lexemes, language code, and so on. For more information, see Managing Lexicons.- Alphabet Alphabet
- LanguageCode LanguageCode
- LastModified LastModified
- LexemesCount LexemesCount
- LexiconArn LexiconArn
- Size Size
LexiconContent
- LexiconContent
string
LexiconDescription
- LexiconDescription
object
: Describes the content of the lexicon.- Attributes LexiconAttributes
- Name LexiconName
LexiconDescriptionList
- LexiconDescriptionList
array
- items LexiconDescription
LexiconName
- LexiconName
string
LexiconNameList
- LexiconNameList
array
- items LexiconName
LexiconNotFoundException
- LexiconNotFoundException
object
: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.
- message ErrorMessage
LexiconSizeExceededException
- LexiconSizeExceededException
object
: The maximum size of the specified lexicon would be exceeded by this operation.- message ErrorMessage
ListLexiconsInput
- ListLexiconsInput
object
ListLexiconsOutput
- ListLexiconsOutput
object
- Lexicons LexiconDescriptionList
- NextToken NextToken
MarksNotSupportedForFormatException
- MarksNotSupportedForFormatException
object
: Speech marks are not supported for theOutputFormat
selected. Speech marks are only available for content injson
format.- message ErrorMessage
MaxLexemeLengthExceededException
- MaxLexemeLengthExceededException
object
: The maximum size of the lexeme would be exceeded by this operation.- message ErrorMessage
MaxLexiconsNumberExceededException
- MaxLexiconsNumberExceededException
object
: The maximum number of lexicons would be exceeded by this operation.- message ErrorMessage
NextToken
- NextToken
string
OutputFormat
- OutputFormat
string
(values: json, mp3, ogg_vorbis, pcm)
PutLexiconInput
- PutLexiconInput
object
- Content required LexiconContent
PutLexiconOutput
- PutLexiconOutput
object
RequestCharacters
- RequestCharacters
integer
SampleRate
- SampleRate
string
ServiceFailureException
- ServiceFailureException
object
: An unknown condition has caused a service failure.- message ErrorMessage
Size
- Size
integer
SpeechMarkType
- SpeechMarkType
string
(values: sentence, ssml, viseme, word)
SpeechMarkTypeList
- SpeechMarkTypeList
array
- items SpeechMarkType
SsmlMarksNotSupportedForTextTypeException
- SsmlMarksNotSupportedForTextTypeException
object
: SSML speech marks are not supported for plain text-type input.- message ErrorMessage
SynthesizeSpeechInput
- SynthesizeSpeechInput
object
- LexiconNames LexiconNameList
- OutputFormat required OutputFormat
- SampleRate SampleRate
- SpeechMarkTypes SpeechMarkTypeList
- Text required Text
- TextType TextType
- VoiceId required VoiceId
SynthesizeSpeechOutput
- SynthesizeSpeechOutput
object
- AudioStream AudioStream
Text
- Text
string
TextLengthExceededException
- TextLengthExceededException
object
: 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.- message ErrorMessage
TextType
- TextType
string
(values: ssml, text)
UnsupportedPlsAlphabetException
- UnsupportedPlsAlphabetException
object
: The alphabet specified by the lexicon is not a supported alphabet. Valid values arex-sampa
andipa
.- message ErrorMessage
UnsupportedPlsLanguageException
- UnsupportedPlsLanguageException
object
: The language specified in the lexicon is unsupported. For a list of supported languages, see Lexicon Attributes.- message ErrorMessage
Voice
- Voice
object
: Description of the voice.- Gender Gender
- Id VoiceId
- LanguageCode LanguageCode
- LanguageName LanguageName
- Name VoiceName
VoiceId
- VoiceId
string
(values: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Matthew, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz, Vicki, Takumi, Seoyeon, Aditi)
VoiceList
- VoiceList
array
- items Voice
VoiceName
- VoiceName
string