libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodePipeline.AcknowledgeJob

Description

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

Synopsis

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
Eq AcknowledgeJob Source # 
Instance details

Defined in Amazonka.CodePipeline.AcknowledgeJob

Methods

(==) :: AcknowledgeJob -> AcknowledgeJob -> Bool #

(/=) :: AcknowledgeJob -> AcknowledgeJob -> Bool #

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 #

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 #

NFData AcknowledgeJob Source # 
Instance details

Defined in Amazonka.CodePipeline.AcknowledgeJob

Methods

rnf :: AcknowledgeJob -> () #

Hashable AcknowledgeJob Source # 
Instance details

Defined in Amazonka.CodePipeline.AcknowledgeJob

Methods

hashWithSalt :: Int -> AcknowledgeJob -> Int #

hash :: AcknowledgeJob -> Int #

ToJSON AcknowledgeJob Source # 
Instance details

Defined in Amazonka.CodePipeline.AcknowledgeJob

Methods

toJSON :: AcknowledgeJob -> Value #

toEncoding :: AcknowledgeJob -> Encoding #

toJSONList :: [AcknowledgeJob] -> Value #

toEncodingList :: [AcknowledgeJob] -> Encoding #

AWSRequest AcknowledgeJob Source # 
Instance details

Defined in Amazonka.CodePipeline.AcknowledgeJob

Associated Types

type AWSResponse AcknowledgeJob #

Methods

request :: AcknowledgeJob -> Request AcknowledgeJob #

response :: MonadResource m => Logger -> Service -> Proxy AcknowledgeJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AcknowledgeJob))) #

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 #

type Rep AcknowledgeJob Source # 
Instance details

Defined in Amazonka.CodePipeline.AcknowledgeJob

type Rep AcknowledgeJob = D1 ('MetaData "AcknowledgeJob" "Amazonka.CodePipeline.AcknowledgeJob" "libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline" 'False) (C1 ('MetaCons "AcknowledgeJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "nonce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse AcknowledgeJob Source # 
Instance details

Defined in Amazonka.CodePipeline.AcknowledgeJob

type AWSResponse AcknowledgeJob = AcknowledgeJobResponse

newAcknowledgeJob Source #

Arguments

:: Text

$sel:jobId:AcknowledgeJob'

-> Text

$sel:nonce: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:

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

$sel:nonce: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

Instances

Instances details
Eq AcknowledgeJobResponse Source # 
Instance details

Defined in Amazonka.CodePipeline.AcknowledgeJob

Methods

(==) :: AcknowledgeJobResponse -> AcknowledgeJobResponse -> Bool #

(/=) :: AcknowledgeJobResponse -> AcknowledgeJobResponse -> Bool #

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 #

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 #

NFData AcknowledgeJobResponse Source # 
Instance details

Defined in Amazonka.CodePipeline.AcknowledgeJob

Methods

rnf :: AcknowledgeJobResponse -> () #

type Rep AcknowledgeJobResponse Source # 
Instance details

Defined in Amazonka.CodePipeline.AcknowledgeJob

type Rep AcknowledgeJobResponse = D1 ('MetaData "AcknowledgeJobResponse" "Amazonka.CodePipeline.AcknowledgeJob" "libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline" '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:

$sel:status: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.