UpdateContainerAgent
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.
Request Syntax
{
"cluster": "string
",
"containerInstance": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- cluster
-
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.
Type: String
Required: No
- containerInstance
-
The container instance ID or full ARN entries for the container instance where you would like to update the Amazon ECS container agent.
Type: String
Required: Yes
Response Syntax
{
"containerInstance": {
"agentConnected": boolean,
"agentUpdateStatus": "string",
"attachments": [
{
"details": [
{
"name": "string",
"value": "string"
}
],
"id": "string",
"status": "string",
"type": "string"
}
],
"attributes": [
{
"name": "string",
"targetId": "string",
"targetType": "string",
"value": "string"
}
],
"capacityProviderName": "string",
"containerInstanceArn": "string",
"ec2InstanceId": "string",
"healthStatus": {
"details": [
{
"lastStatusChange": number,
"lastUpdated": number,
"status": "string",
"type": "string"
}
],
"overallStatus": "string"
},
"pendingTasksCount": number,
"registeredAt": number,
"registeredResources": [
{
"doubleValue": number,
"integerValue": number,
"longValue": number,
"name": "string",
"stringSetValue": [ "string" ],
"type": "string"
}
],
"remainingResources": [
{
"doubleValue": number,
"integerValue": number,
"longValue": number,
"name": "string",
"stringSetValue": [ "string" ],
"type": "string"
}
],
"runningTasksCount": number,
"status": "string",
"statusReason": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"version": number,
"versionInfo": {
"agentHash": "string",
"agentVersion": "string",
"dockerVersion": "string"
}
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- containerInstance
-
The container instance that the container agent was updated for.
Type: ContainerInstance object
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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.
The following list includes additional causes for the error:
-
The
RunTask
could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in thePROVISIONING
per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
HTTP Status Code: 400
-
- ClusterNotFoundException
-
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter isn't valid. Review the available parameters for the API request.
HTTP Status Code: 400
- 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.
HTTP Status Code: 400
- 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.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
- 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
orSTAGING
, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.HTTP Status Code: 400
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS
) must be replaced with an Amazon Signature Version 4
signature. For more information, see Signature
Version 4 Signing Process in the
Amazon General
Reference.
You only need to learn how to sign HTTP requests if you intend to
create them manually. When you use the Amazon Command Line Interface
Example
This example updates the container agent version for the container instance with the ID
53ac7152-dcd1-4102-81f5-208962864132
in the update
cluster.
Sample Request
POST / HTTP/1.1
Host: ecs.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 82
X-Amz-Target: AmazonEC2ContainerServiceV20141113.UpdateContainerAgent
X-Amz-Date: 20150528T152756Z
User-Agent: aws-cli/1.7.30 Python/2.7.9 Darwin/14.3.0
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS
{
"cluster": "update",
"containerInstance": "53ac7152-dcd1-4102-81f5-208962864132"
}
Sample Response
HTTP/1.1 200 OK
Server: Server
Date: Thu, 28 May 2015 15:27:54 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 1033
Connection: keep-alive
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
{
"containerInstance": {
"agentConnected": true,
"agentUpdateStatus": "PENDING",
...
"versionInfo": {
"agentHash": "4023248",
"agentVersion": "1.0.0",
"dockerVersion": "DockerVersion: 1.5.0"
}
}
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: