amazonka-ecs-1.3.6: Amazon EC2 Container Service SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ECS.StopTask

Contents

Description

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.

See: AWS API Reference for StopTask.

Synopsis

Creating a Request

stopTask Source

Arguments

:: Text

stTask

-> StopTask 

Creates a value of StopTask with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

stCluster :: Lens' StopTask (Maybe Text) Source

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..

stTask :: Lens' StopTask Text Source

The task ID or full Amazon Resource Name (ARN) entry of the task to stop.

Destructuring the Response

stopTaskResponse Source

Creates a value of StopTaskResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses

srsTask :: Lens' StopTaskResponse (Maybe Task) Source

Undocumented member.

srsResponseStatus :: Lens' StopTaskResponse Int Source

The response status code.