list_speech_synthesis_tasks¶
Operation¶
list_speech_synthesis_tasks
¶
list_speech_synthesis_tasks(request: ListSpeechSynthesisTasksInput | ListSpeechSynthesisTasksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListSpeechSynthesisTasksInputDict]) -> 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 |
|---|---|---|---|
request
|
ListSpeechSynthesisTasksInput | ListSpeechSynthesisTasksInputDict | 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[ListSpeechSynthesisTasksInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListSpeechSynthesisTasksOutput
|
An instance of |
list_speech_synthesis_tasks
async
¶
list_speech_synthesis_tasks(request: ListSpeechSynthesisTasksInput | ListSpeechSynthesisTasksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListSpeechSynthesisTasksInputDict]) -> 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 |
|---|---|---|---|
request
|
ListSpeechSynthesisTasksInput | ListSpeechSynthesisTasksInputDict | 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[ListSpeechSynthesisTasksInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListSpeechSynthesisTasksOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListSpeechSynthesisTasksInputDict
¶
Bases: TypedDict
Dictionary form of ListSpeechSynthesisTasksInput.
ListSpeechSynthesisTasksInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListSpeechSynthesisTasksInput structure.
Attributes¶
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
Maximum number of speech synthesis tasks returned in a List operation.
Output¶
ListSpeechSynthesisTasksOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListSpeechSynthesisTasksOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.
response_metadata
class-attribute
instance-attribute
¶
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_tasks
class-attribute
instance-attribute
¶
synthesis_tasks: list[SynthesisTask] | 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.