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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.

Synopsis

Creating a Request

acknowledgeJob #

Arguments

:: Text	`ajJobId`
-> Text	`ajNonce`
-> AcknowledgeJob

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

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

ajJobId - The unique system-generated ID of the job for which you want to confirm receipt.
ajNonce - A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.

data AcknowledgeJob #

Represents the input of an acknowledge job action.

See: acknowledgeJob smart constructor.

Instances

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

Request Lenses

ajJobId :: Lens' AcknowledgeJob Text #

The unique system-generated ID of the job for which you want to confirm receipt.

ajNonce :: Lens' AcknowledgeJob Text #

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.

Destructuring the Response

acknowledgeJobResponse #

Arguments

:: Int	`ajrsResponseStatus`
-> AcknowledgeJobResponse

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

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

ajrsStatus - Whether the job worker has received the specified job.
ajrsResponseStatus - -- | The response status code.

data AcknowledgeJobResponse #

Represents the output of an acknowledge job action.

See: acknowledgeJobResponse smart constructor.

Instances

Eq AcknowledgeJobResponse #
Methods (==) :: AcknowledgeJobResponse -> AcknowledgeJobResponse -> Bool # (/=) :: AcknowledgeJobResponse -> AcknowledgeJobResponse -> Bool #
Data AcknowledgeJobResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AcknowledgeJobResponse -> c AcknowledgeJobResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AcknowledgeJobResponse # toConstr :: AcknowledgeJobResponse -> Constr # dataTypeOf :: AcknowledgeJobResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c AcknowledgeJobResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AcknowledgeJobResponse) # gmapT :: (forall b. Data b => b -> b) -> AcknowledgeJobResponse -> AcknowledgeJobResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AcknowledgeJobResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AcknowledgeJobResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> AcknowledgeJobResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AcknowledgeJobResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AcknowledgeJobResponse -> m AcknowledgeJobResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AcknowledgeJobResponse -> m AcknowledgeJobResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AcknowledgeJobResponse -> m AcknowledgeJobResponse #
Read AcknowledgeJobResponse #
Methods readsPrec :: Int -> ReadS AcknowledgeJobResponse # readList :: ReadS [AcknowledgeJobResponse] # readPrec :: ReadPrec AcknowledgeJobResponse # readListPrec :: ReadPrec [AcknowledgeJobResponse] #
Show AcknowledgeJobResponse #
Methods showsPrec :: Int -> AcknowledgeJobResponse -> ShowS # show :: AcknowledgeJobResponse -> String # showList :: [AcknowledgeJobResponse] -> ShowS #
Generic AcknowledgeJobResponse #
Associated Types type Rep AcknowledgeJobResponse :: * -> * # Methods from :: AcknowledgeJobResponse -> Rep AcknowledgeJobResponse x # to :: Rep AcknowledgeJobResponse x -> AcknowledgeJobResponse #
NFData AcknowledgeJobResponse #
Methods rnf :: AcknowledgeJobResponse -> () #
type Rep AcknowledgeJobResponse #
type Rep AcknowledgeJobResponse = D1 (MetaData "AcknowledgeJobResponse" "Network.AWS.CodePipeline.AcknowledgeJob" "amazonka-codepipeline-1.4.5-7l6xH8NU5nx4wRSql2Kh3c" False) (C1 (MetaCons "AcknowledgeJobResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ajrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JobStatus))) (S1 (MetaSel (Just Symbol "_ajrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

ajrsStatus :: Lens' AcknowledgeJobResponse (Maybe JobStatus) #

Whether the job worker has received the specified job.

ajrsResponseStatus :: Lens' AcknowledgeJobResponse Int #

- | The response status code.