Skip to content

get_speech_synthesis_task

Operation

get_speech_synthesis_task

get_speech_synthesis_task(request: GetSpeechSynthesisTaskInput | GetSpeechSynthesisTaskInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSpeechSynthesisTaskInputDict]) -> 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
request GetSpeechSynthesisTaskInput | GetSpeechSynthesisTaskInputDict | 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[GetSpeechSynthesisTaskInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetSpeechSynthesisTaskOutput

An instance of GetSpeechSynthesisTaskOutput.

get_speech_synthesis_task async

get_speech_synthesis_task(request: GetSpeechSynthesisTaskInput | GetSpeechSynthesisTaskInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSpeechSynthesisTaskInputDict]) -> 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
request GetSpeechSynthesisTaskInput | GetSpeechSynthesisTaskInputDict | 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[GetSpeechSynthesisTaskInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetSpeechSynthesisTaskOutput

An instance of GetSpeechSynthesisTaskOutput.

Input

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

GetSpeechSynthesisTaskInputDict

Bases: TypedDict

Dictionary form of GetSpeechSynthesisTaskInput.

Attributes

task_id instance-attribute
task_id: Required[str]

The Amazon Polly generated identifier for a speech synthesis task.

GetSpeechSynthesisTaskInput dataclass

Bases: _SerdeShape

Dataclass for GetSpeechSynthesisTaskInput structure.

Attributes

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

The Amazon Polly generated identifier for a speech synthesis task.

Output

GetSpeechSynthesisTaskOutput dataclass

Bases: _SerdeShape

Dataclass for GetSpeechSynthesisTaskOutput 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 from the requested task, including output format, creation time, task status, and so on.