DeregisterTaskDefinition
Deregisters the specified task definition by family and revision. Upon deregistration, the task
definition is marked as INACTIVE
. Existing tasks and services that reference an
INACTIVE
task definition continue to run without disruption. Existing services that
reference an INACTIVE
task definition can still scale up or down by modifying the
service's desired count. If you want to delete a task definition revision, you must first deregister
the task definition revision.
You can't use an INACTIVE
task definition to run new tasks or create new services, and
you can't update an existing service to reference an INACTIVE
task definition. However,
there may be up to a 10-minute window following deregistration where these restrictions have not yet
taken effect.
Note
At this time, INACTIVE
task definitions remain discoverable in your account
indefinitely. However, this behavior is subject to change in the future. We don't recommend that
you rely on INACTIVE
task definitions persisting beyond the lifecycle of any
associated tasks and services.
You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.
Request Syntax
{
"taskDefinition": "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.
- taskDefinition
-
The
family
andrevision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify arevision
.Type: String
Required: Yes
Response Syntax
{
"taskDefinition": {
"compatibilities": [ "string" ],
"containerDefinitions": [
{
"command": [ "string" ],
"cpu": number,
"credentialSpecs": [ "string" ],
"dependsOn": [
{
"condition": "string",
"containerName": "string"
}
],
"disableNetworking": boolean,
"dnsSearchDomains": [ "string" ],
"dnsServers": [ "string" ],
"dockerLabels": {
"string" : "string"
},
"dockerSecurityOptions": [ "string" ],
"entryPoint": [ "string" ],
"environment": [
{
"name": "string",
"value": "string"
}
],
"environmentFiles": [
{
"type": "string",
"value": "string"
}
],
"essential": boolean,
"extraHosts": [
{
"hostname": "string",
"ipAddress": "string"
}
],
"firelensConfiguration": {
"options": {
"string" : "string"
},
"type": "string"
},
"healthCheck": {
"command": [ "string" ],
"interval": number,
"retries": number,
"startPeriod": number,
"timeout": number
},
"hostname": "string",
"image": "string",
"interactive": boolean,
"links": [ "string" ],
"linuxParameters": {
"capabilities": {
"add": [ "string" ],
"drop": [ "string" ]
},
"devices": [
{
"containerPath": "string",
"hostPath": "string",
"permissions": [ "string" ]
}
],
"initProcessEnabled": boolean,
"maxSwap": number,
"sharedMemorySize": number,
"swappiness": number,
"tmpfs": [
{
"containerPath": "string",
"mountOptions": [ "string" ],
"size": number
}
]
},
"logConfiguration": {
"logDriver": "string",
"options": {
"string" : "string"
},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"memory": number,
"memoryReservation": number,
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],
"name": "string",
"portMappings": [
{
"appProtocol": "string",
"containerPort": number,
"containerPortRange": "string",
"hostPort": number,
"name": "string",
"protocol": "string"
}
],
"privileged": boolean,
"pseudoTerminal": boolean,
"readonlyRootFilesystem": boolean,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"restartPolicy": {
"enabled": boolean,
"ignoredExitCodes": [ number ],
"restartAttemptPeriod": number
},
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"startTimeout": number,
"stopTimeout": number,
"systemControls": [
{
"namespace": "string",
"value": "string"
}
],
"ulimits": [
{
"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string",
"versionConsistency": "string",
"volumesFrom": [
{
"readOnly": boolean,
"sourceContainer": "string"
}
],
"workingDirectory": "string"
}
],
"cpu": "string",
"deregisteredAt": number,
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"family": "string",
"inferenceAccelerators": [
{
"deviceName": "string",
"deviceType": "string"
}
],
"ipcMode": "string",
"memory": "string",
"networkMode": "string",
"pidMode": "string",
"placementConstraints": [
{
"expression": "string",
"type": "string"
}
],
"proxyConfiguration": {
"containerName": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"type": "string"
},
"registeredAt": number,
"registeredBy": "string",
"requiresAttributes": [
{
"name": "string",
"targetId": "string",
"targetType": "string",
"value": "string"
}
],
"requiresCompatibilities": [ "string" ],
"revision": number,
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"status": "string",
"taskDefinitionArn": "string",
"taskRoleArn": "string",
"volumes": [
{
"configuredAtLaunch": boolean,
"dockerVolumeConfiguration": {
"autoprovision": boolean,
"driver": "string",
"driverOpts": {
"string" : "string"
},
"labels": {
"string" : "string"
},
"scope": "string"
},
"efsVolumeConfiguration": {
"authorizationConfig": {
"accessPointId": "string",
"iam": "string"
},
"fileSystemId": "string",
"rootDirectory": "string",
"transitEncryption": "string",
"transitEncryptionPort": number
},
"fsxWindowsFileServerVolumeConfiguration": {
"authorizationConfig": {
"credentialsParameter": "string",
"domain": "string"
},
"fileSystemId": "string",
"rootDirectory": "string"
},
"host": {
"sourcePath": "string"
},
"name": "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.
- taskDefinition
-
The full description of the deregistered task.
Type: TaskDefinition 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
-
- InvalidParameterException
-
The specified parameter isn't valid. Review the available parameters for the API request.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
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
The following example request deregisters the first revision of the cpu-wave
task definition family (cpu-wave:1
). In the resulting output, the task definition
status becomes INACTIVE
.
Sample Request
POST / HTTP/1.1
Host: ecs.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 35
X-Amz-Target: AmazonEC2ContainerServiceV20141113.DeregisterTaskDefinition
X-Amz-Date: 20150429T184806Z
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS
{
"taskDefinition": "cpu-wave:1"
}
Sample Response
HTTP/1.1 200 OK
Server: Server
Date: Fri, 12 Jun 2015 23:07:39 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 491
Connection: keep-alive
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
{
"taskDefinition": {
"containerDefinitions": [
{
"command": [
"apt-get update; apt-get install stress; while true; do stress --cpu $(( RANDOM % 4 )) -t $(( RANDOM % 10 )); done"
],
"cpu": 50,
"entryPoint": [
"bash",
"-c"
],
"environment": [],
"essential": true,
"image": "ubuntu",
"memory": 100,
"mountPoints": [],
"name": "wave",
"portMappings": [],
"volumesFrom": []
}
],
"family": "cpu-wave",
"revision": 1,
"status": "INACTIVE",
"taskDefinitionArn": "arn:aws:ecs:us-west-2:012345678910:task-definition/cpu-wave:1",
"volumes": []
}
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: