describe_container_instances¶
Operation¶
describe_container_instances
¶
describe_container_instances(request: DescribeContainerInstancesInput | DescribeContainerInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeContainerInstancesInputDict]) -> DescribeContainerInstancesOutput
Describes one or more container instances. Returns metadata about each container instance requested.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeContainerInstancesInput | DescribeContainerInstancesInputDict | 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[DescribeContainerInstancesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeContainerInstancesOutput
|
An instance of |
describe_container_instances
async
¶
describe_container_instances(request: DescribeContainerInstancesInput | DescribeContainerInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeContainerInstancesInputDict]) -> DescribeContainerInstancesOutput
Describes one or more container instances. Returns metadata about each container instance requested.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeContainerInstancesInput | DescribeContainerInstancesInputDict | 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[DescribeContainerInstancesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeContainerInstancesOutput
|
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.
DescribeContainerInstancesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeContainerInstancesInput.
Attributes¶
cluster
instance-attribute
¶
cluster: str | None
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.
container_instances
instance-attribute
¶
A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
include
instance-attribute
¶
Specifies whether you want to see the resource tags for the container
instance. If TAGS is specified, the tags are included in the response.
If CONTAINER_INSTANCE_HEALTH is specified, the container instance
health is included in the response. If this field is omitted, tags and
container instance health status aren't included in the response.
DescribeContainerInstancesInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
cluster
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 describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.
container_instances
class-attribute
instance-attribute
¶
A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
include
class-attribute
instance-attribute
¶
Specifies whether you want to see the resource tags for the container
instance. If TAGS is specified, the tags are included in the response.
If CONTAINER_INSTANCE_HEALTH is specified, the container instance
health is included in the response. If this field is omitted, tags and
container instance health status aren't included in the response.
Output¶
DescribeContainerInstancesOutput
dataclass
¶
Bases: _SerdeShape
Attributes¶
container_instances
class-attribute
instance-attribute
¶
container_instances: list[ContainerInstance] | None = ...
The list of container instances.
failures
class-attribute
instance-attribute
¶
Any failures associated with the call.
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.