We are excited to announce our new API Documentation.
Optional CreationTimestamp for the time the synthesis task was started.
Optional EngineSpecifies 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.
Optional LanguageOptional 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.
Optional LexiconList 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.
Optional OutputThe 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.
Optional OutputPathway for the output speech file.
Optional RequestNumber of billable characters synthesized.
Optional SampleThe 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".
Optional SnsARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
Optional SpeechThe type of speech marks returned for the input text.
Optional TaskThe Amazon Polly generated identifier for a speech synthesis task.
Optional TaskCurrent status of the individual speech synthesis task.
Optional TaskReason for the current status of a specific speech synthesis task, including errors if the task has failed.
Optional TextSpecifies whether the input text is plain text or SSML. The default value is plain text.
Optional VoiceVoice ID to use for the synthesis.
SynthesisTask object that provides information about a speech synthesis task.