list_speech_synthesis_tasks¶
Operation¶
async
¶
list_speech_synthesis_tasks(input: ListSpeechSynthesisTasksInput, plugins: list[Plugin] | None = None) -> ListSpeechSynthesisTasksOutput
Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListSpeechSynthesisTasksInput
|
An instance of |
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 |
|---|---|
ListSpeechSynthesisTasksOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListSpeechSynthesisTasksInput structure.
Attributes¶
class-attribute
instance-attribute
¶
max_results: int | None = None
Maximum number of speech synthesis tasks returned in a List operation.
class-attribute
instance-attribute
¶
next_token: str | None = None
The pagination token to use in the next request to continue the listing of speech synthesis tasks.
class-attribute
instance-attribute
¶
status: TaskStatus | None = None
Status of the speech synthesis tasks returned in a List operation
Output¶
dataclass
¶
Dataclass for ListSpeechSynthesisTasksOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = None
An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.
class-attribute
instance-attribute
¶
synthesis_tasks: list[SynthesisTask] | None = None
List of SynthesisTask objects that provides information from the specified task in the list request, including output format, creation time, task status, and so on.