Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ECS.StopTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data StopTask = StopTask' {
- cluster :: Maybe Text
- reason :: Maybe Text
- task :: Text
}
newStopTask :: Text -> StopTask
stopTask_cluster :: Lens' StopTask (Maybe Text)
stopTask_reason :: Lens' StopTask (Maybe Text)
stopTask_task :: Lens' StopTask Text
data StopTaskResponse = StopTaskResponse' {
- task :: Maybe Task
- httpStatus :: Int
}
newStopTaskResponse :: Int -> StopTaskResponse
stopTaskResponse_task :: Lens' StopTaskResponse (Maybe Task)
stopTaskResponse_httpStatus :: Lens' StopTaskResponse Int

Creating a Request

data StopTask Source #

See: newStopTask smart constructor.

Constructors

StopTask'

Fields

cluster :: Maybe Text
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.
reason :: Maybe Text
An optional message specified when a task is stopped. For example, if you are 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. Up to 255 characters are allowed in this message.
task :: Text
The task ID or full Amazon Resource Name (ARN) of the task to stop.

Instances

Instances details

Eq StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask Methods (==) :: StopTask -> StopTask -> Bool # (/=) :: StopTask -> StopTask -> Bool #
Read StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask Methods readsPrec :: Int -> ReadS StopTask # readList :: ReadS [StopTask] # readPrec :: ReadPrec StopTask # readListPrec :: ReadPrec [StopTask] #
Show StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask Methods showsPrec :: Int -> StopTask -> ShowS # show :: StopTask -> String # showList :: [StopTask] -> ShowS #
Generic StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask Associated Types type Rep StopTask :: Type -> Type # Methods from :: StopTask -> Rep StopTask x # to :: Rep StopTask x -> StopTask #
NFData StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask Methods rnf :: StopTask -> () #
Hashable StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask Methods hashWithSalt :: Int -> StopTask -> Int # hash :: StopTask -> Int #
ToJSON StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask Methods toJSON :: StopTask -> Value # toEncoding :: StopTask -> Encoding # toJSONList :: [StopTask] -> Value # toEncodingList :: [StopTask] -> Encoding #
AWSRequest StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask Associated Types type AWSResponse StopTask # Methods request :: StopTask -> Request StopTask # response :: MonadResource m => Logger -> Service -> Proxy StopTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopTask))) #
ToHeaders StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask Methods toHeaders :: StopTask -> [Header] #
ToPath StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask Methods toPath :: StopTask -> ByteString #
ToQuery StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask Methods toQuery :: StopTask -> QueryString #
type Rep StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask type Rep StopTask = D1 ('MetaData "StopTask" "Amazonka.ECS.StopTask" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "StopTask'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "task") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StopTask Source #
Instance details Defined in Amazonka.ECS.StopTask type AWSResponse StopTask = StopTaskResponse

newStopTask Source #

Arguments

:: Text	`$sel:task:StopTask'`
-> StopTask

Create a value of StopTask with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cluster:StopTask', stopTask_cluster - 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.

$sel:reason:StopTask', stopTask_reason - An optional message specified when a task is stopped. For example, if you are 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. Up to 255 characters are allowed in this message.

$sel:task:StopTask', stopTask_task - The task ID or full Amazon Resource Name (ARN) of the task to stop.

Request Lenses

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

stopTask_reason :: Lens' StopTask (Maybe Text) Source #

An optional message specified when a task is stopped. For example, if you are 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. Up to 255 characters are allowed in this message.

stopTask_task :: Lens' StopTask Text Source #

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

Destructuring the Response

data StopTaskResponse Source #

See: newStopTaskResponse smart constructor.

Constructors

StopTaskResponse'
Fields task :: Maybe Task The task that was stopped. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StopTaskResponse Source #
Instance details Defined in Amazonka.ECS.StopTask Methods (==) :: StopTaskResponse -> StopTaskResponse -> Bool # (/=) :: StopTaskResponse -> StopTaskResponse -> Bool #
Read StopTaskResponse Source #
Instance details Defined in Amazonka.ECS.StopTask Methods readsPrec :: Int -> ReadS StopTaskResponse # readList :: ReadS [StopTaskResponse] # readPrec :: ReadPrec StopTaskResponse # readListPrec :: ReadPrec [StopTaskResponse] #
Show StopTaskResponse Source #
Instance details Defined in Amazonka.ECS.StopTask Methods showsPrec :: Int -> StopTaskResponse -> ShowS # show :: StopTaskResponse -> String # showList :: [StopTaskResponse] -> ShowS #
Generic StopTaskResponse Source #
Instance details Defined in Amazonka.ECS.StopTask Associated Types type Rep StopTaskResponse :: Type -> Type # Methods from :: StopTaskResponse -> Rep StopTaskResponse x # to :: Rep StopTaskResponse x -> StopTaskResponse #
NFData StopTaskResponse Source #
Instance details Defined in Amazonka.ECS.StopTask Methods rnf :: StopTaskResponse -> () #
type Rep StopTaskResponse Source #
Instance details Defined in Amazonka.ECS.StopTask type Rep StopTaskResponse = D1 ('MetaData "StopTaskResponse" "Amazonka.ECS.StopTask" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "StopTaskResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "task") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Task)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopTaskResponse Source #

Arguments

:: Int	`$sel:httpStatus:StopTaskResponse'`
-> StopTaskResponse

Create a value of StopTaskResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:task:StopTask', stopTaskResponse_task - The task that was stopped.

$sel:httpStatus:StopTaskResponse', stopTaskResponse_httpStatus - The response's http status code.

Response Lenses

stopTaskResponse_task :: Lens' StopTaskResponse (Maybe Task) Source #

The task that was stopped.

stopTaskResponse_httpStatus :: Lens' StopTaskResponse Int Source #

The response's http status code.