AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
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.
For .NET Core this operation is only available in asynchronous form. Please refer to StopTaskAsync.
Namespace: Amazon.ECS
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z
public abstract StopTaskResponse StopTask( StopTaskRequest request )
Container for the necessary parameters to execute the StopTask service method.
| Exception | Condition |
|---|---|
| ClientException | These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid. |
| ClusterNotFoundException | The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. |
| InvalidParameterException | The specified parameter isn't valid. Review the available parameters for the API request. |
| ServerException | These errors are usually caused by a server issue. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5