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.PollForThirdPartyJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.

When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.

Creating a Request

data PollForThirdPartyJobs Source #

Represents the input of a PollForThirdPartyJobs action.

See: newPollForThirdPartyJobs smart constructor.

Constructors

PollForThirdPartyJobs'
Fields maxBatchSize :: Maybe Natural The maximum number of jobs to return in a poll for jobs call. actionTypeId :: ActionTypeId Represents information about an action type.

Instances

Instances details

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

newPollForThirdPartyJobs Source #

Arguments

:: ActionTypeId	`PollForThirdPartyJobs`
-> PollForThirdPartyJobs

Create a value of PollForThirdPartyJobs 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:maxBatchSize:PollForThirdPartyJobs', pollForThirdPartyJobs_maxBatchSize - The maximum number of jobs to return in a poll for jobs call.

PollForThirdPartyJobs, pollForThirdPartyJobs_actionTypeId - Represents information about an action type.

Request Lenses

pollForThirdPartyJobs_maxBatchSize :: Lens' PollForThirdPartyJobs (Maybe Natural) Source #

The maximum number of jobs to return in a poll for jobs call.

pollForThirdPartyJobs_actionTypeId :: Lens' PollForThirdPartyJobs ActionTypeId Source #

Represents information about an action type.

Destructuring the Response

data PollForThirdPartyJobsResponse Source #

Represents the output of a PollForThirdPartyJobs action.

See: newPollForThirdPartyJobsResponse smart constructor.

Constructors

PollForThirdPartyJobsResponse'
Fields jobs :: Maybe [ThirdPartyJob] Information about the jobs to take action on. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newPollForThirdPartyJobsResponse Source #

Arguments

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

Create a value of PollForThirdPartyJobsResponse 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:jobs:PollForThirdPartyJobsResponse', pollForThirdPartyJobsResponse_jobs - Information about the jobs to take action on.

$sel:httpStatus:PollForThirdPartyJobsResponse', pollForThirdPartyJobsResponse_httpStatus - The response's http status code.

Response Lenses

pollForThirdPartyJobsResponse_jobs :: Lens' PollForThirdPartyJobsResponse (Maybe [ThirdPartyJob]) Source #

Information about the jobs to take action on.

pollForThirdPartyJobsResponse_httpStatus :: Lens' PollForThirdPartyJobsResponse Int Source #

The response's http status code.