Network.AWS.Batch.TerminateJob

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED . Jobs that have not progressed to the STARTING state are cancelled.

Creating a Request

terminateJob

Arguments

:: Text

tjJobId

-> Text

tjReason

-> TerminateJob

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

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

• tjJobId - The AWS Batch job ID of the job to terminate.
• tjReason - A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

data TerminateJob

See: terminateJob smart constructor.

Instances

Eq TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Methods

(==) :: TerminateJob -> TerminateJob -> Bool

(/=) :: TerminateJob -> TerminateJob -> Bool

Data TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TerminateJob -> c TerminateJob

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TerminateJob

toConstr :: TerminateJob -> Constr

dataTypeOf :: TerminateJob -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TerminateJob)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TerminateJob)

gmapT :: (forall b. Data b => b -> b) -> TerminateJob -> TerminateJob

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TerminateJob -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TerminateJob -> r

gmapQ :: (forall d. Data d => d -> u) -> TerminateJob -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TerminateJob -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TerminateJob -> m TerminateJob

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TerminateJob -> m TerminateJob

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TerminateJob -> m TerminateJob

Read TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Methods

readsPrec :: Int -> ReadS TerminateJob

readList :: ReadS [TerminateJob]

readPrec :: ReadPrec TerminateJob

readListPrec :: ReadPrec [TerminateJob]

Show TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Methods

showsPrec :: Int -> TerminateJob -> ShowS

show :: TerminateJob -> String

showList :: [TerminateJob] -> ShowS

Generic TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Associated Types

type Rep TerminateJob :: Type -> Type

Methods

from :: TerminateJob -> Rep TerminateJob x

to :: Rep TerminateJob x -> TerminateJob

Hashable TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Methods

hashWithSalt :: Int -> TerminateJob -> Int

hash :: TerminateJob -> Int

ToJSON TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Methods

toJSON :: TerminateJob -> Value

toEncoding :: TerminateJob -> Encoding

toJSONList :: [TerminateJob] -> Value

toEncodingList :: [TerminateJob] -> Encoding

AWSRequest TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Associated Types

type Rs TerminateJob :: Type

Methods

request :: TerminateJob -> Request TerminateJob

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy TerminateJob -> ClientResponse -> m (Response TerminateJob)

ToHeaders TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Methods

toHeaders :: TerminateJob -> [Header]

ToPath TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Methods

toPath :: TerminateJob -> ByteString

ToQuery TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Methods

toQuery :: TerminateJob -> QueryString

NFData TerminateJob

Defined in Network.AWS.Batch.TerminateJob

Methods

rnf :: TerminateJob -> ()

type Rep TerminateJob

Defined in Network.AWS.Batch.TerminateJob

type Rep TerminateJob = D1 (MetaData "TerminateJob" "Network.AWS.Batch.TerminateJob" "amazonka-batch-1.6.1-Ehms0ZM7bO3CGJpCkHVC0C" False) (C1 (MetaCons "TerminateJob'" PrefixI True) (S1 (MetaSel (Just "_tjJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_tjReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

type Rs TerminateJob

Defined in Network.AWS.Batch.TerminateJob

type Rs TerminateJob = TerminateJobResponse

Request Lenses

tjJobId :: Lens' TerminateJob Text

The AWS Batch job ID of the job to terminate.

tjReason :: Lens' TerminateJob Text

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Destructuring the Response

terminateJobResponse

Arguments

:: Int

tjrsResponseStatus

-> TerminateJobResponse

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

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

• tjrsResponseStatus - -- | The response status code.

data TerminateJobResponse

See: terminateJobResponse smart constructor.

Instances

Eq TerminateJobResponse

Defined in Network.AWS.Batch.TerminateJob

Methods

(==) :: TerminateJobResponse -> TerminateJobResponse -> Bool

(/=) :: TerminateJobResponse -> TerminateJobResponse -> Bool

Data TerminateJobResponse

Defined in Network.AWS.Batch.TerminateJob

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TerminateJobResponse -> c TerminateJobResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TerminateJobResponse

toConstr :: TerminateJobResponse -> Constr

dataTypeOf :: TerminateJobResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TerminateJobResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TerminateJobResponse)

gmapT :: (forall b. Data b => b -> b) -> TerminateJobResponse -> TerminateJobResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TerminateJobResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TerminateJobResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> TerminateJobResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TerminateJobResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TerminateJobResponse -> m TerminateJobResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TerminateJobResponse -> m TerminateJobResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TerminateJobResponse -> m TerminateJobResponse

Read TerminateJobResponse

Defined in Network.AWS.Batch.TerminateJob

Methods

readsPrec :: Int -> ReadS TerminateJobResponse

readList :: ReadS [TerminateJobResponse]

readPrec :: ReadPrec TerminateJobResponse

readListPrec :: ReadPrec [TerminateJobResponse]

Show TerminateJobResponse

Defined in Network.AWS.Batch.TerminateJob

Methods

showsPrec :: Int -> TerminateJobResponse -> ShowS

show :: TerminateJobResponse -> String

showList :: [TerminateJobResponse] -> ShowS

Generic TerminateJobResponse

Defined in Network.AWS.Batch.TerminateJob

Associated Types

type Rep TerminateJobResponse :: Type -> Type

Methods

from :: TerminateJobResponse -> Rep TerminateJobResponse x

to :: Rep TerminateJobResponse x -> TerminateJobResponse

NFData TerminateJobResponse

Defined in Network.AWS.Batch.TerminateJob

Methods

rnf :: TerminateJobResponse -> ()

type Rep TerminateJobResponse

Defined in Network.AWS.Batch.TerminateJob

type Rep TerminateJobResponse = D1 (MetaData "TerminateJobResponse" "Network.AWS.Batch.TerminateJob" "amazonka-batch-1.6.1-Ehms0ZM7bO3CGJpCkHVC0C" True) (C1 (MetaCons "TerminateJobResponse'" PrefixI True) (S1 (MetaSel (Just "_tjrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

tjrsResponseStatus :: Lens' TerminateJobResponse Int

• - | The response status code.