amazonka-codepipeline-1.6.0: Amazon CodePipeline SDK.

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

Network.AWS.CodePipeline.PollForJobs

Contents

Description

Returns information about any jobs for AWS CodePipeline to act upon. PollForJobs is only valid for action types with Custom in the owner field. If the action type contains AWS or ThirdParty in the owner field, the PollForJobs action returns an error.

Important: When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.

Synopsis

Creating a Request

pollForJobs Source #

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

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

  • pfjMaxBatchSize - The maximum number of jobs to return in a poll for jobs call.
  • pfjQueryParam - A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.
  • pfjActionTypeId - Represents information about an action type.

data PollForJobs Source #

Represents the input of a PollForJobs action.

See: pollForJobs smart constructor.

Instances

Eq PollForJobs Source # 
Data PollForJobs Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PollForJobs -> c PollForJobs #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PollForJobs #

toConstr :: PollForJobs -> Constr #

dataTypeOf :: PollForJobs -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PollForJobs) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PollForJobs) #

gmapT :: (forall b. Data b => b -> b) -> PollForJobs -> PollForJobs #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PollForJobs -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PollForJobs -> r #

gmapQ :: (forall d. Data d => d -> u) -> PollForJobs -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PollForJobs -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PollForJobs -> m PollForJobs #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PollForJobs -> m PollForJobs #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PollForJobs -> m PollForJobs #

Read PollForJobs Source # 
Show PollForJobs Source # 
Generic PollForJobs Source # 

Associated Types

type Rep PollForJobs :: * -> * #

Hashable PollForJobs Source # 
ToJSON PollForJobs Source # 
NFData PollForJobs Source # 

Methods

rnf :: PollForJobs -> () #

AWSRequest PollForJobs Source # 
ToHeaders PollForJobs Source # 

Methods

toHeaders :: PollForJobs -> [Header] #

ToPath PollForJobs Source # 
ToQuery PollForJobs Source # 
type Rep PollForJobs Source # 
type Rep PollForJobs = D1 * (MetaData "PollForJobs" "Network.AWS.CodePipeline.PollForJobs" "amazonka-codepipeline-1.6.0-EK1TXgMpZBH3zXFbRFQIXQ" False) (C1 * (MetaCons "PollForJobs'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_pfjMaxBatchSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_pfjQueryParam") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) (S1 * (MetaSel (Just Symbol "_pfjActionTypeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ActionTypeId)))))
type Rs PollForJobs Source # 

Request Lenses

pfjMaxBatchSize :: Lens' PollForJobs (Maybe Natural) Source #

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

pfjQueryParam :: Lens' PollForJobs (HashMap Text Text) Source #

A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.

pfjActionTypeId :: Lens' PollForJobs ActionTypeId Source #

Represents information about an action type.

Destructuring the Response

pollForJobsResponse Source #

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

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

data PollForJobsResponse Source #

Represents the output of a PollForJobs action.

See: pollForJobsResponse smart constructor.

Instances

Eq PollForJobsResponse Source # 
Data PollForJobsResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PollForJobsResponse -> c PollForJobsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PollForJobsResponse #

toConstr :: PollForJobsResponse -> Constr #

dataTypeOf :: PollForJobsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PollForJobsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PollForJobsResponse) #

gmapT :: (forall b. Data b => b -> b) -> PollForJobsResponse -> PollForJobsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PollForJobsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PollForJobsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> PollForJobsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PollForJobsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PollForJobsResponse -> m PollForJobsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PollForJobsResponse -> m PollForJobsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PollForJobsResponse -> m PollForJobsResponse #

Show PollForJobsResponse Source # 
Generic PollForJobsResponse Source # 
NFData PollForJobsResponse Source # 

Methods

rnf :: PollForJobsResponse -> () #

type Rep PollForJobsResponse Source # 
type Rep PollForJobsResponse = D1 * (MetaData "PollForJobsResponse" "Network.AWS.CodePipeline.PollForJobs" "amazonka-codepipeline-1.6.0-EK1TXgMpZBH3zXFbRFQIXQ" False) (C1 * (MetaCons "PollForJobsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_pfjrsJobs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Job]))) (S1 * (MetaSel (Just Symbol "_pfjrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

pfjrsJobs :: Lens' PollForJobsResponse [Job] Source #

Information about the jobs to take action on.

pfjrsResponseStatus :: Lens' PollForJobsResponse Int Source #

  • - | The response status code.