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

StartTask

Starts a new task from the specified task definition on the specified container instance or instances.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon EC2 Container Service Developer Guide.

Request Syntax

Copy
{ "cluster": "string", "containerInstances": [ "string" ], "group": "string", "overrides": { "containerOverrides": [ { "command": [ "string" ], "environment": [ { "name": "string", "value": "string" } ], "name": "string" } ], "taskRoleArn": "string" }, "startedBy": "string", "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.

cluster

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

Type: String

Required: No

containerInstances

The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

Type: Array of strings

Required: Yes

group

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

Type: String

Required: No

overrides

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

Note

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

Type: TaskOverride object

Required: No

startedBy

An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Type: String

Required: No

taskDefinition

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

Type: String

Required: Yes

Response Syntax

Copy
{ "failures": [ { "arn": "string", "reason": "string" } ], "tasks": [ { "clusterArn": "string", "containerInstanceArn": "string", "containers": [ { "containerArn": "string", "exitCode": number, "lastStatus": "string", "name": "string", "networkBindings": [ { "bindIP": "string", "containerPort": number, "hostPort": number, "protocol": "string" } ], "reason": "string", "taskArn": "string" } ], "createdAt": number, "desiredStatus": "string", "group": "string", "lastStatus": "string", "overrides": { "containerOverrides": [ { "command": [ "string" ], "environment": [ { "name": "string", "value": "string" } ], "name": "string" } ], "taskRoleArn": "string" }, "startedAt": number, "startedBy": "string", "stoppedAt": number, "stoppedReason": "string", "taskArn": "string", "taskDefinitionArn": "string", "version": number } ] }

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.

failures

Any failures associated with the call.

Type: Array of Failure objects

tasks

A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.

Type: Array of Task objects

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

ClusterNotFoundException

The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

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 starts the latest ACTIVE revision of the hello_world task definition family in the default cluster on the container instance with the ID 4c543eed-f83f-47da-b1d8-3d23f1da4c64.

Sample Request

Copy
POST / HTTP/1.1 Host: ecs.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 97 X-Amz-Target: AmazonEC2ContainerServiceV20141113.StartTask X-Amz-Date: 20161121T220032Z User-Agent: aws-cli/1.11.13 Python/2.7.12 Darwin/16.1.0 botocore/1.4.66 Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS { "containerInstances": [ "4c543eed-f83f-47da-b1d8-3d23f1da4c64" ], "taskDefinition": "hello_world" }

Sample Response

Copy
HTTP/1.1 200 OK Server: Server Date: Mon, 21 Nov 2016 22:00:32 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 1025 Connection: keep-alive x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f { "failures": [], "tasks": [ { "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/4c543eed-f83f-47da-b1d8-3d23f1da4c64", "containers": [ { "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/e76594d4-27e1-4c74-98b5-46a6435eb769", "lastStatus": "PENDING", "name": "wordpress", "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/fdf2c302-468c-4e55-b884-5331d816e7fb" }, { "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/b19106ea-4fa8-4f1d-9767-96922c82b070", "lastStatus": "PENDING", "name": "mysql", "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/fdf2c302-468c-4e55-b884-5331d816e7fb" } ], "createdAt": 1479765460.842, "desiredStatus": "RUNNING", "lastStatus": "PENDING", "overrides": { "containerOverrides": [ { "name": "wordpress" }, { "name": "mysql" } ] }, "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/fdf2c302-468c-4e55-b884-5331d816e7fb", "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", "version": 1 } ] }

See Also

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