Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.Batch.CancelJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED , PENDING , or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled); these jobs must be terminated with the TerminateJob operation.

Synopsis

cancelJob :: Text -> Text -> CancelJob
data CancelJob
cjJobId :: Lens' CancelJob Text
cjReason :: Lens' CancelJob Text
cancelJobResponse :: Int -> CancelJobResponse
data CancelJobResponse
cjrsResponseStatus :: Lens' CancelJobResponse Int

Creating a Request

cancelJob Source #

Arguments

:: Text	`cjJobId`
-> Text	`cjReason`
-> CancelJob

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

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

cjJobId - The AWS Batch job ID of the job to cancel.
cjReason - 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 CancelJob Source #

See: cancelJob smart constructor.

Instances

Eq CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods (==) :: CancelJob -> CancelJob -> Bool # (/=) :: CancelJob -> CancelJob -> Bool #
Data CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CancelJob -> c CancelJob # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CancelJob # toConstr :: CancelJob -> Constr # dataTypeOf :: CancelJob -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CancelJob) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CancelJob) # gmapT :: (forall b. Data b => b -> b) -> CancelJob -> CancelJob # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CancelJob -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CancelJob -> r # gmapQ :: (forall d. Data d => d -> u) -> CancelJob -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CancelJob -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CancelJob -> m CancelJob # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CancelJob -> m CancelJob # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CancelJob -> m CancelJob #
Read CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods readsPrec :: Int -> ReadS CancelJob # readList :: ReadS [CancelJob] # readPrec :: ReadPrec CancelJob # readListPrec :: ReadPrec [CancelJob] #
Show CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods showsPrec :: Int -> CancelJob -> ShowS # show :: CancelJob -> String # showList :: [CancelJob] -> ShowS #
Generic CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Associated Types type Rep CancelJob :: Type -> Type # Methods from :: CancelJob -> Rep CancelJob x # to :: Rep CancelJob x -> CancelJob #
Hashable CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods hashWithSalt :: Int -> CancelJob -> Int # hash :: CancelJob -> Int #
ToJSON CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods toJSON :: CancelJob -> Value # toEncoding :: CancelJob -> Encoding # toJSONList :: [CancelJob] -> Value # toEncodingList :: [CancelJob] -> Encoding #
AWSRequest CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Associated Types type Rs CancelJob :: Type # Methods request :: CancelJob -> Request CancelJob # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CancelJob -> ClientResponse -> m (Response CancelJob) #
ToHeaders CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods toHeaders :: CancelJob -> [Header] #
ToPath CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods toPath :: CancelJob -> ByteString #
ToQuery CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods toQuery :: CancelJob -> QueryString #
NFData CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods rnf :: CancelJob -> () #
type Rep CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob type Rep CancelJob = D1 (MetaData "CancelJob" "Network.AWS.Batch.CancelJob" "amazonka-batch-1.6.1-Ehms0ZM7bO3CGJpCkHVC0C" False) (C1 (MetaCons "CancelJob'" PrefixI True) (S1 (MetaSel (Just "_cjJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cjReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Rs CancelJob Source #
Instance details Defined in Network.AWS.Batch.CancelJob type Rs CancelJob = CancelJobResponse

Request Lenses

cjJobId :: Lens' CancelJob Text Source #

The AWS Batch job ID of the job to cancel.

cjReason :: Lens' CancelJob Text Source #

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

cancelJobResponse Source #

Arguments

:: Int	`cjrsResponseStatus`
-> CancelJobResponse

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

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

cjrsResponseStatus - -- | The response status code.

data CancelJobResponse Source #

See: cancelJobResponse smart constructor.

Instances

Eq CancelJobResponse Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods (==) :: CancelJobResponse -> CancelJobResponse -> Bool # (/=) :: CancelJobResponse -> CancelJobResponse -> Bool #
Data CancelJobResponse Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CancelJobResponse -> c CancelJobResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CancelJobResponse # toConstr :: CancelJobResponse -> Constr # dataTypeOf :: CancelJobResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CancelJobResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CancelJobResponse) # gmapT :: (forall b. Data b => b -> b) -> CancelJobResponse -> CancelJobResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CancelJobResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CancelJobResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CancelJobResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CancelJobResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CancelJobResponse -> m CancelJobResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CancelJobResponse -> m CancelJobResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CancelJobResponse -> m CancelJobResponse #
Read CancelJobResponse Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods readsPrec :: Int -> ReadS CancelJobResponse # readList :: ReadS [CancelJobResponse] # readPrec :: ReadPrec CancelJobResponse # readListPrec :: ReadPrec [CancelJobResponse] #
Show CancelJobResponse Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods showsPrec :: Int -> CancelJobResponse -> ShowS # show :: CancelJobResponse -> String # showList :: [CancelJobResponse] -> ShowS #
Generic CancelJobResponse Source #
Instance details Defined in Network.AWS.Batch.CancelJob Associated Types type Rep CancelJobResponse :: Type -> Type # Methods from :: CancelJobResponse -> Rep CancelJobResponse x # to :: Rep CancelJobResponse x -> CancelJobResponse #
NFData CancelJobResponse Source #
Instance details Defined in Network.AWS.Batch.CancelJob Methods rnf :: CancelJobResponse -> () #
type Rep CancelJobResponse Source #
Instance details Defined in Network.AWS.Batch.CancelJob type Rep CancelJobResponse = D1 (MetaData "CancelJobResponse" "Network.AWS.Batch.CancelJob" "amazonka-batch-1.6.1-Ehms0ZM7bO3CGJpCkHVC0C" True) (C1 (MetaCons "CancelJobResponse'" PrefixI True) (S1 (MetaSel (Just "_cjrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

cjrsResponseStatus :: Lens' CancelJobResponse Int Source #

- | The response status code.