list_daemons¶
Operation¶
async
¶
list_daemons(input: ListDaemonsInput, plugins: list[Plugin] | None = None) -> ListDaemonsOutput
Returns a list of daemons. You can filter the results by cluster or capacity provider.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListDaemonsInput
|
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 |
|---|---|
ListDaemonsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListDaemonsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
The Amazon Resource Names (ARNs) of the capacity providers to filter daemons by. Only daemons associated with the specified capacity providers are returned.
class-attribute
instance-attribute
¶
cluster_arn: str | None = ...
The Amazon Resource Name (ARN) of the cluster to filter daemons by. If you do not specify a cluster, the default cluster is assumed.
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of daemon results that ListDaemons returned in
paginated output. When this parameter is used, ListDaemons 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 ListDaemons request with the returned
nextToken value. This value can be between 1 and 100. If this
parameter isn't used, then ListDaemons 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 ListDaemons 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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListDaemonsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
daemon_summaries_list: list[DaemonSummary] | None = ...
The list of daemon summaries.
class-attribute
instance-attribute
¶
next_token: str | None = ...
The nextToken value to include in a future ListDaemons request. When
the results of a ListDaemons 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.