Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- 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
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.
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
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:
pfjrsJobs
- Information about the jobs to take action on.pfjrsResponseStatus
- -- | The response status code.
data PollForJobsResponse Source #
Represents the output of a PollForJobs action.
See: pollForJobsResponse
smart constructor.
Response Lenses
pfjrsResponseStatus :: Lens' PollForJobsResponse Int Source #
- - | The response status code.