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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStopTask and EndStopTask.
Namespace: Amazon.ECS
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z
public virtual Task<StopTaskResponse> StopTaskAsync( StopTaskRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the StopTask service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
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 Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5