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

Network.AWS.ElasticTranscoder.CancelJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The CancelJob operation cancels an unfinished job.

Synopsis

Creating a Request

cancelJob #

Arguments

:: Text	`cjId`
-> 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:

cjId - The identifier of the job that you want to cancel. To get a list of the jobs (including their jobId ) that have a status of Submitted , use the ListJobsByStatus API action.

data CancelJob #

The CancelJobRequest structure.

See: cancelJob smart constructor.

Instances

Eq CancelJob #
Methods (==) :: CancelJob -> CancelJob -> Bool # (/=) :: CancelJob -> CancelJob -> Bool #
Data 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 #
Methods readsPrec :: Int -> ReadS CancelJob # readList :: ReadS [CancelJob] # readPrec :: ReadPrec CancelJob # readListPrec :: ReadPrec [CancelJob] #
Show CancelJob #
Methods showsPrec :: Int -> CancelJob -> ShowS # show :: CancelJob -> String # showList :: [CancelJob] -> ShowS #
Generic CancelJob #
Associated Types type Rep CancelJob :: * -> * # Methods from :: CancelJob -> Rep CancelJob x # to :: Rep CancelJob x -> CancelJob #
Hashable CancelJob #
Methods hashWithSalt :: Int -> CancelJob -> Int # hash :: CancelJob -> Int #
NFData CancelJob #
Methods rnf :: CancelJob -> () #
AWSRequest CancelJob #
Associated Types type Rs CancelJob :: * # Methods request :: CancelJob -> Request CancelJob # response :: MonadResource m => Logger -> Service -> Proxy * CancelJob -> ClientResponse -> m (Response CancelJob) #
ToQuery CancelJob #
Methods toQuery :: CancelJob -> QueryString #
ToPath CancelJob #
Methods toPath :: CancelJob -> ByteString #
ToHeaders CancelJob #
Methods toHeaders :: CancelJob -> [Header] #
type Rep CancelJob #
type Rep CancelJob = D1 (MetaData "CancelJob" "Network.AWS.ElasticTranscoder.CancelJob" "amazonka-elastictranscoder-1.4.5-IWhO0jSg9d9K4YiAeruaf2" True) (C1 (MetaCons "CancelJob'" PrefixI True) (S1 (MetaSel (Just Symbol "_cjId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs CancelJob #
type Rs CancelJob = CancelJobResponse

Request Lenses

cjId :: Lens' CancelJob Text #

The identifier of the job that you want to cancel. To get a list of the jobs (including their jobId ) that have a status of Submitted , use the ListJobsByStatus API action.

Destructuring the Response

cancelJobResponse #

Arguments

:: Int	`canrsResponseStatus`
-> 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:

canrsResponseStatus - -- | The response status code.

data CancelJobResponse #

The response body contains a JSON object. If the job is successfully canceled, the value of Success is true .

See: cancelJobResponse smart constructor.

Instances

Eq CancelJobResponse #
Methods (==) :: CancelJobResponse -> CancelJobResponse -> Bool # (/=) :: CancelJobResponse -> CancelJobResponse -> Bool #
Data CancelJobResponse #
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 #
Methods readsPrec :: Int -> ReadS CancelJobResponse # readList :: ReadS [CancelJobResponse] # readPrec :: ReadPrec CancelJobResponse # readListPrec :: ReadPrec [CancelJobResponse] #
Show CancelJobResponse #
Methods showsPrec :: Int -> CancelJobResponse -> ShowS # show :: CancelJobResponse -> String # showList :: [CancelJobResponse] -> ShowS #
Generic CancelJobResponse #
Associated Types type Rep CancelJobResponse :: * -> * # Methods from :: CancelJobResponse -> Rep CancelJobResponse x # to :: Rep CancelJobResponse x -> CancelJobResponse #
NFData CancelJobResponse #
Methods rnf :: CancelJobResponse -> () #
type Rep CancelJobResponse #
type Rep CancelJobResponse = D1 (MetaData "CancelJobResponse" "Network.AWS.ElasticTranscoder.CancelJob" "amazonka-elastictranscoder-1.4.5-IWhO0jSg9d9K4YiAeruaf2" True) (C1 (MetaCons "CancelJobResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_canrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

canrsResponseStatus :: Lens' CancelJobResponse Int #

- | The response status code.