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

SubmitTaskStateChange

Note

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

Request Syntax

{
   "attachments": [ 
      { 
         "attachmentArn": "string",
         "status": "string"
      }
   ],
   "cluster": "string",
   "containers": [ 
      { 
         "containerName": "string",
         "exitCode": number,
         "networkBindings": [ 
            { 
               "bindIP": "string",
               "containerPort": number,
               "hostPort": number,
               "protocol": "string"
            }
         ],
         "reason": "string",
         "status": "string"
      }
   ],
   "executionStoppedAt": number,
   "pullStartedAt": number,
   "pullStoppedAt": number,
   "reason": "string",
   "status": "string",
   "task": "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.

attachments

Any attachments associated with the state change request.

Type: Array of AttachmentStateChange objects

Required: No

cluster

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

Type: String

Required: No

containers

Any containers associated with the state change request.

Type: Array of ContainerStateChange objects

Required: No

executionStoppedAt

The Unix timestamp for when the task execution stopped.

Type: Timestamp

Required: No

pullStartedAt

The Unix time stamp for when the container image pull began.

Type: Timestamp

Required: No

pullStoppedAt

The Unix time stamp for when the container image pull completed.

Type: Timestamp

Required: No

reason

The reason for the state change request.

Type: String

Required: No

status

The status of the state change request.

Type: String

Required: No

task

The task ID or full ARN of the task in the state change request.

Type: String

Required: No

Response Syntax

{
   "acknowledgment": "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.

acknowledgment

Acknowledgement of the state change.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have authorization to perform the requested action.

HTTP Status Code: 400

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 permissions to use the action or resource, or specifying an identifier that is not valid.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

See Also

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