AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the PollForJobs operation.
Returns information about any jobs for CodePipeline to act on.
When this API is called, 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.
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.
Namespace: Amazon.CodePipeline.Model
Assembly: AWSSDK.CodePipeline.dll
Version: 3.x.y.z
public class PollForJobsRequest : AmazonCodePipelineRequest IAmazonWebServiceRequest
The PollForJobsRequest type exposes the following members
Name | Description | |
---|---|---|
PollForJobsRequest() |
Name | Type | Description | |
---|---|---|---|
ActionTypeId | Amazon.CodePipeline.Model.ActionTypeId |
Gets and sets the property ActionTypeId. Represents information about an action type. |
|
MaxBatchSize | System.Int32 |
Gets and sets the property MaxBatchSize. The maximum number of jobs to return in a poll for jobs call. |
|
QueryParam | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property 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. |
This example returns information about any jobs for a job worker to act upon. This command is only used for custom actions. When this command is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline. This command will also return any secret values defined for the action, if any are defined.
var client = new AmazonCodePipelineClient(); var response = client.PollForJobs(new PollForJobsRequest { ActionTypeId = new ActionTypeId { Version = "1", Category = "Test", Owner = "Custom", Provider = "MyJenkinsProviderName" }, MaxBatchSize = 5, QueryParam = new Dictionary<string, string> { { "ProjectName", "MyJenkinsTestProj" } } }); List<Job> jobs = response.Jobs;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5