Skip to content

ECS  >  Operations  >  update_container_agent

update_container_agent

Operation

update_container_agent async 

update_container_agent(input: UpdateContainerAgentInput, plugins: list[Plugin] | None = None) -> UpdateContainerAgentOutput

Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.

Note

The UpdateContainerAgent API isn't supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package. This updates the agent. For more information, see Updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

Note: Agent updates with the UpdateContainerAgent API operation do not apply to Windows container instances. We recommend that you launch new container instances to update the agent version in your Windows clusters.

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

Parameters:

Name Type Description Default
input UpdateContainerAgentInput

An instance of UpdateContainerAgentInput.

 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
UpdateContainerAgentOutput

An instance of UpdateContainerAgentOutput.

Input

UpdateContainerAgentInput 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 your container instance is running on. If you do not specify a cluster, the default cluster is assumed.

container_instance class-attribute instance-attribute 
container_instance: str | None = ...

The container instance ID or full ARN entries for the container instance where you would like to update the Amazon ECS container agent.

Output

UpdateContainerAgentOutput dataclass

Bases: _SerdeShape

Attributes

container_instance class-attribute instance-attribute 
container_instance: ContainerInstance | None = ...

The container instance that the container agent was updated for.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

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.