amazonka-codepipeline-1.4.5: Amazon CodePipeline SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@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.

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 #

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 - Undocumented member.

data PollForJobs #

Represents the input of a poll for jobs action.

See: pollForJobs smart constructor.

Instances

Eq PollForJobs # 
Data PollForJobs # 

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 # 
Show PollForJobs # 
Generic PollForJobs # 

Associated Types

type Rep PollForJobs :: * -> * #

Hashable PollForJobs # 
ToJSON PollForJobs # 
NFData PollForJobs # 

Methods

rnf :: PollForJobs -> () #

AWSRequest PollForJobs # 
ToQuery PollForJobs # 
ToPath PollForJobs # 
ToHeaders PollForJobs # 

Methods

toHeaders :: PollForJobs -> [Header] #

type Rep PollForJobs # 
type Rep PollForJobs = D1 (MetaData "PollForJobs" "Network.AWS.CodePipeline.PollForJobs" "amazonka-codepipeline-1.4.5-7l6xH8NU5nx4wRSql2Kh3c" 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 # 

Request Lenses

pfjMaxBatchSize :: Lens' PollForJobs (Maybe Natural) #

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

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

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.

Destructuring the Response

pollForJobsResponse #

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 #

Represents the output of a poll for jobs action.

See: pollForJobsResponse smart constructor.

Instances

Eq PollForJobsResponse # 
Data PollForJobsResponse # 

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 #

Read PollForJobsResponse # 
Show PollForJobsResponse # 
Generic PollForJobsResponse # 
NFData PollForJobsResponse # 

Methods

rnf :: PollForJobsResponse -> () #

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

Response Lenses

pfjrsJobs :: Lens' PollForJobsResponse [Job] #

Information about the jobs to take action on.

pfjrsResponseStatus :: Lens' PollForJobsResponse Int #

  • - | The response status code.