list_container_instances¶
Operation¶
async
¶
list_container_instances(input: ListContainerInstancesInput, plugins: list[Plugin] | None = None) -> ListContainerInstancesOutput
Returns a list of container instances in a specified cluster. You can
filter the results of a ListContainerInstances operation with cluster
query language statements inside the filter parameter. For more
information, see Cluster Query
Language
in the Amazon Elastic Container Service Developer Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListContainerInstancesInput
|
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 |
|---|---|
ListContainerInstancesOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
cluster: str | None = ...
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
class-attribute
instance-attribute
¶
filter: str | None = ...
You can filter the results of a ListContainerInstances operation with
cluster query language statements. For more information, see Cluster
Query
Language
in the Amazon Elastic Container Service Developer Guide.
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of container instance results that
ListContainerInstances returned in paginated output. When this
parameter is used, ListContainerInstances 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
ListContainerInstances request with the returned nextToken value.
This value can be between 1 and 100. If this parameter isn't used, then
ListContainerInstances 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 ListContainerInstances request
indicating that more results are available to fulfill the request and
further calls are needed. If maxResults was provided, it's 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
¶
status: str | None = ...
Filters the container instances by status. For example, if you specify
the DRAINING status, the results include only container instances that
have been set to DRAINING using
UpdateContainerInstancesState.
If you don't specify this parameter, the The default is to include
container instances set to all states other than INACTIVE.
Output¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
The list of container instances with full ARN entries for each container instance associated with the specified cluster.
class-attribute
instance-attribute
¶
next_token: str | None = ...
The nextToken value to include in a future ListContainerInstances
request. When the results of a ListContainerInstances 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.