| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CodePipeline.PollForJobs
Description
Returns information about any jobs for AWS CodePipeline to act upon.
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.
See: AWS API Reference for PollForJobs.
- pollForJobs :: ActionTypeId -> PollForJobs
- data PollForJobs
- pfjMaxBatchSize :: Lens' PollForJobs (Maybe Natural)
- pfjQueryParam :: Lens' PollForJobs (HashMap Text Text)
- pfjActionTypeId :: Lens' PollForJobs ActionTypeId
- pollForJobsResponse :: Int -> PollForJobsResponse
- data PollForJobsResponse
- pfjrsJobs :: Lens' PollForJobsResponse [Job]
- pfjrsResponseStatus :: Lens' PollForJobsResponse Int
Creating a Request
Arguments
| :: ActionTypeId | |
| -> 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:
data PollForJobs Source
Represents the input of a poll for jobs action.
See: pollForJobs smart constructor.
Instances
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
Undocumented member.
Destructuring the Response
Arguments
| :: Int | |
| -> 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 Source
Represents the output of a poll for jobs action.
See: pollForJobsResponse smart constructor.
Response Lenses
pfjrsJobs :: Lens' PollForJobsResponse [Job] Source
Information about the jobs to take action on.
pfjrsResponseStatus :: Lens' PollForJobsResponse Int Source
The response status code.