Skip to content

start_speech_synthesis_task

Operation

start_speech_synthesis_task

start_speech_synthesis_task(request: StartSpeechSynthesisTaskInput | StartSpeechSynthesisTaskInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartSpeechSynthesisTaskInputDict]) -> StartSpeechSynthesisTaskOutput

Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.

Parameters:

Name Type Description Default
request StartSpeechSynthesisTaskInput | StartSpeechSynthesisTaskInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[StartSpeechSynthesisTaskInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartSpeechSynthesisTaskOutput

An instance of StartSpeechSynthesisTaskOutput.

start_speech_synthesis_task async

start_speech_synthesis_task(request: StartSpeechSynthesisTaskInput | StartSpeechSynthesisTaskInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartSpeechSynthesisTaskInputDict]) -> StartSpeechSynthesisTaskOutput

Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.

Parameters:

Name Type Description Default
request StartSpeechSynthesisTaskInput | StartSpeechSynthesisTaskInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[StartSpeechSynthesisTaskInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartSpeechSynthesisTaskOutput

An instance of StartSpeechSynthesisTaskOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

StartSpeechSynthesisTaskInputDict

Bases: TypedDict

Dictionary form of StartSpeechSynthesisTaskInput.

Attributes

engine instance-attribute
engine: str | None

Specifies the engine (standard, neural, long-form or generative) 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.

language_code instance-attribute
language_code: str | None

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.

lexicon_names instance-attribute
lexicon_names: Sequence[str] | None

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.

output_format instance-attribute
output_format: Required[str]

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

output_s3_bucket_name instance-attribute
output_s3_bucket_name: Required[str]

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

output_s3_key_prefix instance-attribute
output_s3_key_prefix: str | None

The Amazon S3 key prefix for the output speech file.

sample_rate instance-attribute
sample_rate: str | None

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". The default value for long-form voices is "24000". The default value for generative voices is "24000".

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

Valid value for ogg_opus is "48000".

Valid value for mu-law and a-law is "8000".

sns_topic_arn instance-attribute
sns_topic_arn: str | None

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

speech_mark_types instance-attribute
speech_mark_types: Sequence[str] | None

The type of speech marks returned for the input text.

text instance-attribute
text: Required[str]

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

text_type instance-attribute
text_type: str | None

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

voice_id instance-attribute
voice_id: Required[str]

Voice ID to use for the synthesis.

StartSpeechSynthesisTaskInput dataclass

Bases: _SerdeShape

Dataclass for StartSpeechSynthesisTaskInput structure.

Attributes

engine class-attribute instance-attribute
engine: str | None = ...

Specifies the engine (standard, neural, long-form or generative) 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.

language_code class-attribute instance-attribute
language_code: str | None = ...

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.

lexicon_names class-attribute instance-attribute
lexicon_names: list[str] | None = ...

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.

output_format class-attribute instance-attribute
output_format: str | None = ...

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

output_s3_bucket_name class-attribute instance-attribute
output_s3_bucket_name: str | None = ...

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

output_s3_key_prefix class-attribute instance-attribute
output_s3_key_prefix: str | None = ...

The Amazon S3 key prefix for the output speech file.

sample_rate class-attribute instance-attribute
sample_rate: str | None = ...

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". The default value for long-form voices is "24000". The default value for generative voices is "24000".

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

Valid value for ogg_opus is "48000".

Valid value for mu-law and a-law is "8000".

sns_topic_arn class-attribute instance-attribute
sns_topic_arn: str | None = ...

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

speech_mark_types class-attribute instance-attribute
speech_mark_types: list[str] | None = ...

The type of speech marks returned for the input text.

text class-attribute instance-attribute
text: str | None = ...

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

text_type class-attribute instance-attribute
text_type: str | None = ...

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

voice_id class-attribute instance-attribute
voice_id: str | None = ...

Voice ID to use for the synthesis.

Output

StartSpeechSynthesisTaskOutput dataclass

Bases: _SerdeShape

Dataclass for StartSpeechSynthesisTaskOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

synthesis_task class-attribute instance-attribute
synthesis_task: SynthesisTask | None = ...

SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.