StopTask

Stops a running task.

When StopTask is called on a task, the equivalent of docker
stop is issued to the containers running in the task. This results in a
SIGTERM and a default 30-second timeout, after which
SIGKILL is sent and the containers are forcibly stopped. If the
container handles the SIGTERM gracefully and exits within 30 seconds from
receiving it, no SIGKILL is sent.

Note

The default 30-second timeout can be configured on the Amazon ECS container agent
with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see
Amazon ECS Container Agent Configuration in the
Amazon EC2 Container Service Developer Guide.

An optional message specified when a task is stopped. For example, if you are using
a custom scheduler, you can use this parameter to specify the reason for stopping
the
task here, and the message will appear in subsequent DescribeTasks API
operations on this task. Up to 255 characters are allowed in this message.

Response Elements

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 stops a task with the ID
a126249b-b7e4-4b06-9d8f-1b56e75a99b5 in the default
cluster.