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

Task

Details on a task in a cluster.

Contents

attachments

The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.

Type: Array of Attachment objects

Required: No

clusterArn

The ARN of the cluster that hosts the task.

Type: String

Required: No

containerInstanceArn

The ARN of the container instances that host the task.

Type: String

Required: No

containers

The containers associated with the task.

Type: Array of Container objects

Required: No

createdAt

The Unix time stamp for when the task was created (the task entered the PENDING state).

Type: Timestamp

Required: No

desiredStatus

The desired status of the task.

Type: String

Required: No

group

The name of the task group associated with the task.

Type: String

Required: No

lastStatus

The last known status of the task.

Type: String

Required: No

overrides

One or more container overrides.

Type: TaskOverride object

Required: No

startedAt

The Unix time stamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).

Type: Timestamp

Required: No

startedBy

The tag specified when a task is started. If the 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

stoppedAt

The Unix time stamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).

Type: Timestamp

Required: No

stoppedReason

The reason the task was stopped.

Type: String

Required: No

taskArn

The Amazon Resource Name (ARN) of the task.

Type: String

Required: No

taskDefinitionArn

The ARN of the task definition that creates the task.

Type: String

Required: No

version

The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

Type: Long

Required: No

See Also

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

On this page: