list_task_definitions¶
Operation¶
async
¶
list_task_definitions(input: ListTaskDefinitionsInput, plugins: list[Plugin] | None = None) -> ListTaskDefinitionsOutput
Returns a list of task definitions that are registered to your account.
You can filter the results by family name with the familyPrefix
parameter or by status with the status parameter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListTaskDefinitionsInput
|
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 |
|---|---|
ListTaskDefinitionsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
family_prefix: str | None = ...
The full family name to filter the ListTaskDefinitions results with.
Specifying a familyPrefix limits the listed task definitions to task
definition revisions that belong to that family.
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of task definition results that ListTaskDefinitions
returned in paginated output. When this parameter is used,
ListTaskDefinitions only returns maxResults results in a single page
along with a nextToken response element. The remaining results of the
initial request can be seen by sending another ListTaskDefinitions
request with the returned nextToken value. This value can be between 1
and 100. If this parameter isn't used, then ListTaskDefinitions
returns up to 100 results and a nextToken value if applicable.
class-attribute
instance-attribute
¶
next_token: str | None = ...
The nextToken value returned from a ListTaskDefinitions request
indicating that more results are available to fulfill the request and
further calls will be needed. If maxResults was provided, it is
possible the number of results to be fewer than maxResults.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
class-attribute
instance-attribute
¶
sort: str | None = ...
The order to sort the results in. Valid values are ASC and DESC. By
default, (ASC) task definitions are listed lexicographically by family
name and in ascending numerical order by revision so that the newest
task definitions in a family are listed last. Setting this parameter to
DESC reverses the sort order on family name and revision. This is so
that the newest task definitions in a family are listed first.
class-attribute
instance-attribute
¶
status: str | None = ...
The task definition status to filter the ListTaskDefinitions results
with. By default, only ACTIVE task definitions are listed. By setting
this parameter to INACTIVE, you can view task definitions that are
INACTIVE as long as an active task or service still references them.
If you paginate the resulting output, be sure to keep the status value
constant in each subsequent request.
Output¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = ...
The nextToken value to include in a future ListTaskDefinitions
request. When the results of a ListTaskDefinitions request exceed
maxResults, this value can be used to retrieve the next page of
results. This value is null when there are no more results to return.
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.