| Copyright | (c) 2013-2021 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 |
Amazonka.CodePipeline.PollForJobs
Description
Returns information about any jobs for AWS CodePipeline to act on.
PollForJobs is valid only 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.
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. This API also returns any secret values defined for the action.
Synopsis
- data PollForJobs = PollForJobs' {}
- newPollForJobs :: ActionTypeId -> PollForJobs
- pollForJobs_maxBatchSize :: Lens' PollForJobs (Maybe Natural)
- pollForJobs_queryParam :: Lens' PollForJobs (Maybe (HashMap Text Text))
- pollForJobs_actionTypeId :: Lens' PollForJobs ActionTypeId
- data PollForJobsResponse = PollForJobsResponse' {
- jobs :: Maybe [Job]
- httpStatus :: Int
- newPollForJobsResponse :: Int -> PollForJobsResponse
- pollForJobsResponse_jobs :: Lens' PollForJobsResponse (Maybe [Job])
- pollForJobsResponse_httpStatus :: Lens' PollForJobsResponse Int
Creating a Request
data PollForJobs Source #
Represents the input of a PollForJobs action.
See: newPollForJobs smart constructor.
Constructors
| PollForJobs' | |
Fields
| |
Instances
Arguments
| :: ActionTypeId | |
| -> PollForJobs |
Create a value of PollForJobs 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:PollForJobs', pollForJobs_maxBatchSize - The maximum number of jobs to return in a poll for jobs call.
$sel:queryParam:PollForJobs', pollForJobs_queryParam - 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 are
returned.
$sel:actionTypeId:PollForJobs', pollForJobs_actionTypeId - Represents information about an action type.
Request Lenses
pollForJobs_maxBatchSize :: Lens' PollForJobs (Maybe Natural) Source #
The maximum number of jobs to return in a poll for jobs call.
pollForJobs_queryParam :: Lens' PollForJobs (Maybe (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 are returned.
pollForJobs_actionTypeId :: Lens' PollForJobs ActionTypeId Source #
Represents information about an action type.
Destructuring the Response
data PollForJobsResponse Source #
Represents the output of a PollForJobs action.
See: newPollForJobsResponse smart constructor.
Constructors
| PollForJobsResponse' | |
Fields
| |
Instances
newPollForJobsResponse Source #
Arguments
| :: Int | |
| -> PollForJobsResponse |
Create a value of PollForJobsResponse 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:PollForJobsResponse', pollForJobsResponse_jobs - Information about the jobs to take action on.
$sel:httpStatus:PollForJobsResponse', pollForJobsResponse_httpStatus - The response's http status code.
Response Lenses
pollForJobsResponse_jobs :: Lens' PollForJobsResponse (Maybe [Job]) Source #
Information about the jobs to take action on.
pollForJobsResponse_httpStatus :: Lens' PollForJobsResponse Int Source #
The response's http status code.