Skip to content

UpdateContainerInstancesStateRequest

Source code in docs_src/capo_ecs/types/update_container_instances_state_request.py
class UpdateContainerInstancesStateRequest(TypedDict, closed=True):
    cluster: NotRequired["capo_ecs.types.string.String"]
    """<p>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.</p>"""
    container_instances: "capo_ecs.types.string_list.StringList"
    """<p>A list of up to 10 container instance IDs or full ARN entries.</p>"""
    status: "capo_ecs.types.container_instance_status.ContainerInstanceStatus"
    """<p>The container instance state to update the container instance with. The only valid values for this action are <code>ACTIVE</code> and <code>DRAINING</code>. A container instance can only be updated to <code>DRAINING</code> status once it has reached an <code>ACTIVE</code> state. If a container instance is in <code>REGISTERING</code>, <code>DEREGISTERING</code>, or <code>REGISTRATION_FAILED</code> state you can describe the container instance but can't update the container instance state.</p>"""

cluster instance-attribute

cluster: NotRequired[String]

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

container_instances: StringList

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.