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.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. Get this number from the response of the PollForJobs request that returned this job.

data AcknowledgeJob #

Represents the input of an AcknowledgeJob action.

See: acknowledgeJob smart constructor.

Instances

Eq AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods (==) :: AcknowledgeJob -> AcknowledgeJob -> Bool # (/=) :: AcknowledgeJob -> AcknowledgeJob -> Bool #
Data AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.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 #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods readsPrec :: Int -> ReadS AcknowledgeJob # readList :: ReadS [AcknowledgeJob] # readPrec :: ReadPrec AcknowledgeJob # readListPrec :: ReadPrec [AcknowledgeJob] #
Show AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods showsPrec :: Int -> AcknowledgeJob -> ShowS # show :: AcknowledgeJob -> String # showList :: [AcknowledgeJob] -> ShowS #
Generic AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Associated Types type Rep AcknowledgeJob :: * -> * # Methods from :: AcknowledgeJob -> Rep AcknowledgeJob x # to :: Rep AcknowledgeJob x -> AcknowledgeJob #
Hashable AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods hashWithSalt :: Int -> AcknowledgeJob -> Int # hash :: AcknowledgeJob -> Int #
ToJSON AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods toJSON :: AcknowledgeJob -> Value # toEncoding :: AcknowledgeJob -> Encoding # toJSONList :: [AcknowledgeJob] -> Value # toEncodingList :: [AcknowledgeJob] -> Encoding #
AWSRequest AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Associated Types type Rs AcknowledgeJob :: * # Methods request :: AcknowledgeJob -> Request AcknowledgeJob # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy AcknowledgeJob -> ClientResponse -> m (Response AcknowledgeJob) #
ToHeaders AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods toHeaders :: AcknowledgeJob -> [Header] #
ToPath AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods toPath :: AcknowledgeJob -> ByteString #
ToQuery AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods toQuery :: AcknowledgeJob -> QueryString #
NFData AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods rnf :: AcknowledgeJob -> () #
type Rep AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob type Rep AcknowledgeJob = D1 (MetaData "AcknowledgeJob" "Network.AWS.CodePipeline.AcknowledgeJob" "amazonka-codepipeline-1.6.0-CC2BPnoufmqE0zbjOUPBZ9" False) (C1 (MetaCons "AcknowledgeJob'" PrefixI True) (S1 (MetaSel (Just "_ajJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ajNonce") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Rs AcknowledgeJob #
Instance details Defined in Network.AWS.CodePipeline.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. Get this number from the response of the PollForJobs request that returned this job.

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

See: acknowledgeJobResponse smart constructor.

Instances

Eq AcknowledgeJobResponse #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods (==) :: AcknowledgeJobResponse -> AcknowledgeJobResponse -> Bool # (/=) :: AcknowledgeJobResponse -> AcknowledgeJobResponse -> Bool #
Data AcknowledgeJobResponse #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob 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 #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods readsPrec :: Int -> ReadS AcknowledgeJobResponse # readList :: ReadS [AcknowledgeJobResponse] # readPrec :: ReadPrec AcknowledgeJobResponse # readListPrec :: ReadPrec [AcknowledgeJobResponse] #
Show AcknowledgeJobResponse #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods showsPrec :: Int -> AcknowledgeJobResponse -> ShowS # show :: AcknowledgeJobResponse -> String # showList :: [AcknowledgeJobResponse] -> ShowS #
Generic AcknowledgeJobResponse #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Associated Types type Rep AcknowledgeJobResponse :: * -> * # Methods from :: AcknowledgeJobResponse -> Rep AcknowledgeJobResponse x # to :: Rep AcknowledgeJobResponse x -> AcknowledgeJobResponse #
NFData AcknowledgeJobResponse #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob Methods rnf :: AcknowledgeJobResponse -> () #
type Rep AcknowledgeJobResponse #
Instance details Defined in Network.AWS.CodePipeline.AcknowledgeJob type Rep AcknowledgeJobResponse = D1 (MetaData "AcknowledgeJobResponse" "Network.AWS.CodePipeline.AcknowledgeJob" "amazonka-codepipeline-1.6.0-CC2BPnoufmqE0zbjOUPBZ9" False) (C1 (MetaCons "AcknowledgeJobResponse'" PrefixI True) (S1 (MetaSel (Just "_ajrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 (MetaSel (Just "_ajrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (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.