AWS SDK Version 2 for .NET
API Reference

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.

.NET Framework 4.5
 
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 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.

Namespace: Amazon.ECS
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public abstract StopTaskResponse StopTask(
         StopTaskRequest request
)

Parameters

request
Type: Amazon.ECS.Model.StopTaskRequest

Container for the necessary parameters to execute the StopTask service method.

Return Value
Type: Amazon.ECS.Model.StopTaskResponse
The response from the StopTask service method, as returned by ECS.

Exceptions

ExceptionCondition
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.
ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.
InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
ServerException These errors are usually caused by a server issue.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5