• Public
  • Public/Protected
  • All

Interface StartSpeechSynthesisTaskCommandInput




Optional Engine

Engine: 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.

Optional LanguageCode

LanguageCode: LanguageCode | string

Optional language code for the Speech Synthesis request. 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 LexiconNames

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: OutputFormat | string | undefined

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.


OutputS3BucketName: string | undefined

Amazon S3 bucket name to which the output file will be saved.

Optional OutputS3KeyPrefix

OutputS3KeyPrefix: undefined | string

The Amazon S3 key prefix for the output speech file.

Optional SampleRate

SampleRate: undefined | 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".

Optional SnsTopicArn

SnsTopicArn: undefined | string

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

Optional SpeechMarkTypes

SpeechMarkTypes: (SpeechMarkType | string)[]

The type of speech marks returned for the input text.


Text: string | undefined

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

Optional TextType

TextType: TextType | string

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


VoiceId: VoiceId | string | undefined

Voice ID to use for the synthesis.