Skip to content

Polly  >  Operations  >  get_speech_synthesis_task

get_speech_synthesis_task

Operation

get_speech_synthesis_task async 

get_speech_synthesis_task(input: GetSpeechSynthesisTaskInput, plugins: list[Plugin] | None = None) -> GetSpeechSynthesisTaskOutput

Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.

Parameters:

Name Type Description Default
input GetSpeechSynthesisTaskInput

An instance of GetSpeechSynthesisTaskInput.

 required
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

Returns:

Type Description
GetSpeechSynthesisTaskOutput

An instance of GetSpeechSynthesisTaskOutput.

Input

GetSpeechSynthesisTaskInput dataclass

Dataclass for GetSpeechSynthesisTaskInput structure.

Attributes

task_id class-attribute instance-attribute 
task_id: str | None = None

The Amazon Polly generated identifier for a speech synthesis task.

Output

GetSpeechSynthesisTaskOutput dataclass

Dataclass for GetSpeechSynthesisTaskOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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 = None

SynthesisTask object that provides information from the requested task, including output format, creation time, task status, and so on.