Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.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. Used for custom actions only.

Creating a Request

data AcknowledgeJob Source #

Represents the input of an AcknowledgeJob action.

See: newAcknowledgeJob smart constructor.

Constructors

AcknowledgeJob'
Fields jobId :: Text The unique system-generated ID of the job for which you want to confirm receipt. nonce :: 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.

Instances

Instances details

ToJSON AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods toJSON :: AcknowledgeJob -> Value # toEncoding :: AcknowledgeJob -> Encoding # toJSONList :: [AcknowledgeJob] -> Value # toEncodingList :: [AcknowledgeJob] -> Encoding #
ToHeaders AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods toHeaders :: AcknowledgeJob -> [Header] #
ToPath AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods toPath :: AcknowledgeJob -> ByteString #
ToQuery AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods toQuery :: AcknowledgeJob -> QueryString #
AWSRequest AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Associated Types type AWSResponse AcknowledgeJob # Methods request :: (Service -> Service) -> AcknowledgeJob -> Request AcknowledgeJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AcknowledgeJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AcknowledgeJob))) #
Generic AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Associated Types type Rep AcknowledgeJob :: Type -> Type # Methods from :: AcknowledgeJob -> Rep AcknowledgeJob x # to :: Rep AcknowledgeJob x -> AcknowledgeJob #
Read AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods readsPrec :: Int -> ReadS AcknowledgeJob # readList :: ReadS [AcknowledgeJob] # readPrec :: ReadPrec AcknowledgeJob # readListPrec :: ReadPrec [AcknowledgeJob] #
Show AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods showsPrec :: Int -> AcknowledgeJob -> ShowS # show :: AcknowledgeJob -> String # showList :: [AcknowledgeJob] -> ShowS #
NFData AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods rnf :: AcknowledgeJob -> () #
Eq AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods (==) :: AcknowledgeJob -> AcknowledgeJob -> Bool # (/=) :: AcknowledgeJob -> AcknowledgeJob -> Bool #
Hashable AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods hashWithSalt :: Int -> AcknowledgeJob -> Int # hash :: AcknowledgeJob -> Int #
type AWSResponse AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob type AWSResponse AcknowledgeJob = AcknowledgeJobResponse
type Rep AcknowledgeJob Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob type Rep AcknowledgeJob = D1 ('MetaData "AcknowledgeJob" "Amazonka.CodePipeline.AcknowledgeJob" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "AcknowledgeJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "nonce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAcknowledgeJob Source #

Arguments

:: Text	`AcknowledgeJob`
-> Text	`AcknowledgeJob`
-> AcknowledgeJob

Create a value of AcknowledgeJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

AcknowledgeJob, acknowledgeJob_nonce - 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.

Request Lenses

acknowledgeJob_jobId :: Lens' AcknowledgeJob Text Source #

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

acknowledgeJob_nonce :: Lens' AcknowledgeJob Text Source #

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

data AcknowledgeJobResponse Source #

Represents the output of an AcknowledgeJob action.

See: newAcknowledgeJobResponse smart constructor.

Constructors

AcknowledgeJobResponse'
Fields status :: Maybe JobStatus Whether the job worker has received the specified job. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic AcknowledgeJobResponse Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Associated Types type Rep AcknowledgeJobResponse :: Type -> Type # Methods from :: AcknowledgeJobResponse -> Rep AcknowledgeJobResponse x # to :: Rep AcknowledgeJobResponse x -> AcknowledgeJobResponse #
Read AcknowledgeJobResponse Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods readsPrec :: Int -> ReadS AcknowledgeJobResponse # readList :: ReadS [AcknowledgeJobResponse] # readPrec :: ReadPrec AcknowledgeJobResponse # readListPrec :: ReadPrec [AcknowledgeJobResponse] #
Show AcknowledgeJobResponse Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods showsPrec :: Int -> AcknowledgeJobResponse -> ShowS # show :: AcknowledgeJobResponse -> String # showList :: [AcknowledgeJobResponse] -> ShowS #
NFData AcknowledgeJobResponse Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods rnf :: AcknowledgeJobResponse -> () #
Eq AcknowledgeJobResponse Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob Methods (==) :: AcknowledgeJobResponse -> AcknowledgeJobResponse -> Bool # (/=) :: AcknowledgeJobResponse -> AcknowledgeJobResponse -> Bool #
type Rep AcknowledgeJobResponse Source #
Instance details Defined in Amazonka.CodePipeline.AcknowledgeJob type Rep AcknowledgeJobResponse = D1 ('MetaData "AcknowledgeJobResponse" "Amazonka.CodePipeline.AcknowledgeJob" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "AcknowledgeJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAcknowledgeJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:AcknowledgeJobResponse'`
-> AcknowledgeJobResponse

Create a value of AcknowledgeJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AcknowledgeJobResponse, acknowledgeJobResponse_status - Whether the job worker has received the specified job.

$sel:httpStatus:AcknowledgeJobResponse', acknowledgeJobResponse_httpStatus - The response's http status code.

Response Lenses

acknowledgeJobResponse_status :: Lens' AcknowledgeJobResponse (Maybe JobStatus) Source #

Whether the job worker has received the specified job.

acknowledgeJobResponse_httpStatus :: Lens' AcknowledgeJobResponse Int Source #

The response's http status code.