list_daemon_task_definitions¶
Operation¶
async
¶
list_daemon_task_definitions(input: ListDaemonTaskDefinitionsInput, plugins: list[Plugin] | None = None) -> ListDaemonTaskDefinitionsOutput
Returns a list of daemon task definitions that are registered to your account. You can filter the results by family name, status, or both to find daemon task definitions that match your criteria.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListDaemonTaskDefinitionsInput
|
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 |
|---|---|
ListDaemonTaskDefinitionsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListDaemonTaskDefinitionsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
family: str | None = ...
The exact name of the daemon task definition family to filter results with.
class-attribute
instance-attribute
¶
family_prefix: str | None = ...
The full family name to filter the ListDaemonTaskDefinitions results
with. Specifying a familyPrefix limits the listed daemon task
definitions to daemon task definition families that start with the
familyPrefix string.
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of daemon task definition results that
ListDaemonTaskDefinitions returned in paginated output. When this
parameter is used, ListDaemonTaskDefinitions 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
ListDaemonTaskDefinitions request with the returned nextToken value.
This value can be between 1 and 100. If this parameter isn't used, then
ListDaemonTaskDefinitions 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 ListDaemonTaskDefinitions
request indicating that more results are available to fulfill the
request and further calls will be needed. If maxResults was provided,
it's possible for 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
¶
revision: str | None = ...
The revision filter to apply. Specify LAST_REGISTERED to return only
the last registered revision for each daemon task definition family.
class-attribute
instance-attribute
¶
sort: str | None = ...
The order to sort the results. Valid values are ASC and DESC. By
default (ASC), daemon task definitions are listed in ascending order
by family name and revision number.
class-attribute
instance-attribute
¶
status: str | None = ...
The daemon task definition status to filter the
ListDaemonTaskDefinitions results with. By default, only ACTIVE
daemon task definitions are listed. If you set this parameter to
DELETE_IN_PROGRESS, only daemon task definitions that are in the
process of being deleted are listed. If you set this parameter to ALL,
all daemon task definitions are listed regardless of status.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListDaemonTaskDefinitionsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
daemon_task_definitions: list[DaemonTaskDefinitionSummary] | None = ...
The list of daemon task definition summaries.
class-attribute
instance-attribute
¶
next_token: str | None = ...
The nextToken value to include in a future ListDaemonTaskDefinitions
request. When the results of a ListDaemonTaskDefinitions request
exceed maxResults, this value can be used to retrieve the next page of
results.
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.