/AWS1/CL_ECS=>STOPTASK()¶
About StopTask¶
Stops a running task. Any tags associated with the task will be deleted.
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 value and a default 30-second timeout, after which the
SIGKILL value is sent and the containers are forcibly stopped. If the
container handles the SIGTERM value gracefully and exits within 30 seconds
from receiving it, no SIGKILL value is sent.
For Windows containers, POSIX signals do not work and runtime stops the container by sending
a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown
of (Windows) container #25982 on GitHub.
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 Elastic Container Service Developer Guide.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_TASK TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The task ID of the task to stop.
Optional arguments:¶
IV_CLUSTER TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.
IV_REASON TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
An optional message specified when a task is stopped. For example, if you're using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task.