AmazonECSClient.UpdateContainerAgent Method (UpdateContainerAgentRequest)

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.

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.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateContainerAgentAsync.

Namespace: Amazon.ECS
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

public virtual UpdateContainerAgentResponse UpdateContainerAgent(
         UpdateContainerAgentRequest request
)

Parameters

request: Type: Amazon.ECS.Model.UpdateContainerAgentRequest

Container for the necessary parameters to execute the UpdateContainerAgent service method.

Return Value

Type: UpdateContainerAgentResponse

The response from the UpdateContainerAgent service method, as returned by ECS.

Exceptions

Exception	Condition
ClientException	These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
ClusterNotFoundException	The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
InvalidParameterException	The specified parameter isn't valid. Review the available parameters for the API request. For more information about service event errors, see Amazon ECS service event messages.
MissingVersionException	Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and doesn't have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn't use our version information.
NoUpdateAvailableException	There's no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it's so old that there's no update path to the current version.
ServerException	These errors are usually caused by a server issue.
UpdateInProgressException	There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

Examples

This example updates the container agent version on the specified container instance in cluster MyCluster.

To update the container agent version on a container instance


var client = new AmazonECSClient();
var response = client.UpdateContainerAgent(new UpdateContainerAgentRequest 
{
    Cluster = "MyCluster",
    ContainerInstance = "53ac7152-dcd1-4102-81f5-208962864132"
});

ContainerInstance containerInstance = response.ContainerInstance;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonECSClient.UpdateContainerAgent (UpdateContainerAgentRequest)

Method