update_container_instances_state¶
Operation¶
update_container_instances_state
async
¶
update_container_instances_state(request: UpdateContainerInstancesStateInput | UpdateContainerInstancesStateInputDict, /, *, plugins: list[Plugin] | None = None) -> UpdateContainerInstancesStateOutput
update_container_instances_state(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateContainerInstancesStateInputDict]) -> UpdateContainerInstancesStateOutput
Modifies the status of an Amazon ECS container instance.
Once a container instance has reached an ACTIVE state, you can change
the status of a container instance to DRAINING to manually remove an
instance from a cluster, for example to perform system updates, update
the Docker daemon, or scale down the cluster size.
Warning
A container instance can't be changed to DRAINING until it has
reached an ACTIVE status. If the instance is in any other status, an
error will be received.
When you set a container instance to DRAINING, Amazon ECS prevents new
tasks from being scheduled for placement on the container instance and
replacement service tasks are started on other container instances in
the cluster if the resources are available. Service tasks on the
container instance that are in the PENDING state are stopped
immediately.
Service tasks on the container instance that are in the RUNNING state
are stopped and replaced according to the service's deployment
configuration parameters, minimumHealthyPercent and maximumPercent.
You can change the deployment configuration of your service using
UpdateService.
-
If
minimumHealthyPercentis below 100%, the scheduler can ignoredesiredCounttemporarily during task replacement. For example,desiredCountis four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they're in theRUNNINGstate. Tasks for services that use a load balancer are considered healthy if they're in theRUNNINGstate and are reported as healthy by the load balancer. -
The
maximumPercentparameter represents an upper limit on the number of running tasks during task replacement. You can use this to define the replacement batch size. For example, ifdesiredCountis four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service aren't
affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more
RUNNING tasks. You can verify this using
ListTasks.
When a container instance has been drained, you can set a container
instance to ACTIVE status and once it has reached that status the
Amazon ECS scheduler can begin scheduling tasks on the instance again.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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 |
|---|---|
UpdateContainerInstancesStateOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
UpdateContainerInstancesStateInput
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 instance to update. If you do not specify a cluster, the default cluster is assumed.
container_instances
class-attribute
instance-attribute
¶
A list of up to 10 container instance IDs or full ARN entries.
status
class-attribute
instance-attribute
¶
status: str | None = ...
The container instance state to update the container instance with. The
only valid values for this action are ACTIVE and DRAINING. A
container instance can only be updated to DRAINING status once it has
reached an ACTIVE state. If a container instance is in REGISTERING,
DEREGISTERING, or REGISTRATION_FAILED state you can describe the
container instance but can't update the container instance state.
Dictionaries¶
UpdateContainerInstancesStateInputDict
¶
Bases: TypedDict
Dictionary form of UpdateContainerInstancesStateInput.
Attributes¶
cluster
instance-attribute
¶
cluster: str | None
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.
container_instances
instance-attribute
¶
A list of up to 10 container instance IDs or full ARN entries.
status
instance-attribute
¶
The container instance state to update the container instance with. The
only valid values for this action are ACTIVE and DRAINING. A
container instance can only be updated to DRAINING status once it has
reached an ACTIVE state. If a container instance is in REGISTERING,
DEREGISTERING, or REGISTRATION_FAILED state you can describe the
container instance but can't update the container instance state.
Output¶
UpdateContainerInstancesStateOutput
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.