Menu
Amazon EC2 Container Service
API Reference (API Version 2014-11-13)

DescribeTaskDefinition

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

Note

You can only describe INACTIVE task definitions while an active task or service references them.

Request Syntax

Copy
{ "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 for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.

Type: String

Required: Yes

Response Syntax

Copy
{ "taskDefinition": { "containerDefinitions": [ { "command": [ "string" ], "cpu": number, "disableNetworking": boolean, "dnsSearchDomains": [ "string" ], "dnsServers": [ "string" ], "dockerLabels": { "string" : "string" }, "dockerSecurityOptions": [ "string" ], "entryPoint": [ "string" ], "environment": [ { "name": "string", "value": "string" } ], "essential": boolean, "extraHosts": [ { "hostname": "string", "ipAddress": "string" } ], "hostname": "string", "image": "string", "links": [ "string" ], "linuxParameters": { "capabilities": { "add": [ "string" ], "drop": [ "string" ] } }, "logConfiguration": { "logDriver": "string", "options": { "string" : "string" } }, "memory": number, "memoryReservation": number, "mountPoints": [ { "containerPath": "string", "readOnly": boolean, "sourceVolume": "string" } ], "name": "string", "portMappings": [ { "containerPort": number, "hostPort": number, "protocol": "string" } ], "privileged": boolean, "readonlyRootFilesystem": boolean, "ulimits": [ { "hardLimit": number, "name": "string", "softLimit": number } ], "user": "string", "volumesFrom": [ { "readOnly": boolean, "sourceContainer": "string" } ], "workingDirectory": "string" } ], "family": "string", "networkMode": "string", "placementConstraints": [ { "expression": "string", "type": "string" } ], "requiresAttributes": [ { "name": "string", "targetId": "string", "targetType": "string", "value": "string" } ], "revision": number, "status": "string", "taskDefinitionArn": "string", "taskRoleArn": "string", "volumes": [ { "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 task definition description.

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, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

HTTP Status Code: 400

InvalidParameterException

The specified parameter is invalid. 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

Example

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example request provides descriptive information about the 10th revision of a task definition in the hello_world family.

Sample Request

Copy
POST / HTTP/1.1 Host: ecs.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 36 X-Amz-Target: AmazonEC2ContainerServiceV20141113.DescribeTaskDefinition X-Amz-Date: 20150429T190902Z Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS { "taskDefinition": "hello_world:10" }

Sample Response

Copy
HTTP/1.1 200 OK Server: Server Date: Wed, 29 Apr 2015 19:09:03 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 574 Connection: keep-alive x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f { "taskDefinition": { "containerDefinitions": [ { "cpu": 10, "environment": [], "essential": true, "image": "wordpress", "links": [ "mysql" ], "memory": 500, "mountPoints": [], "name": "wordpress", "portMappings": [ { "containerPort": 80, "hostPort": 80 } ], "volumesFrom": [] }, { "cpu": 10, "environment": [ { "name": "MYSQL_ROOT_PASSWORD", "value": "password" } ], "essential": true, "image": "mysql", "memory": 500, "mountPoints": [], "name": "mysql", "portMappings": [], "volumesFrom": [] } ], "family": "hello_world", "revision": 10, "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:10", "volumes": [] } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: