Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface SynthesisTask

SynthesisTask object that provides information about a speech synthesis task.


  • SynthesisTask


CreationTime?: Date

Timestamp for the time the synthesis task was started.

Engine?: string

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.

LanguageCode?: string

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.

LexiconNames?: string[]

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.

OutputFormat?: string

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.

OutputUri?: string

Pathway for the output speech file.

RequestCharacters?: number

Number of billable characters synthesized.

SampleRate?: string

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".

SnsTopicArn?: string

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

SpeechMarkTypes?: string[]

The type of speech marks returned for the input text.

TaskId?: string

The Amazon Polly generated identifier for a speech synthesis task.

TaskStatus?: string

Current status of the individual speech synthesis task.

TaskStatusReason?: string

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

TextType?: string

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

VoiceId?: string

Voice ID to use for the synthesis.