AWS SDK Version 3 for .NET
API Reference

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CodePipeline.AmazonCodePipelineRequest
      Amazon.CodePipeline.Model.PollForJobsRequest

Namespace: Amazon.CodePipeline.Model
Assembly: AWSSDK.CodePipeline.dll
Version: 3.x.y.z

Syntax

C#
public class PollForJobsRequest : AmazonCodePipelineRequest
         IAmazonWebServiceRequest

The PollForJobsRequest type exposes the following members

Constructors

NameDescription
Public Method PollForJobsRequest()

Properties

NameTypeDescription
Public Property ActionTypeId Amazon.CodePipeline.Model.ActionTypeId

Gets and sets the property ActionTypeId.

Represents information about an action type.

Public Property MaxBatchSize System.Int32

Gets and sets the property MaxBatchSize.

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

Public Property 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 will be returned.

Examples

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.

View any available jobs


var response = client.PollForJobs(new PollForJobsRequest 
{
    ActionTypeId = new ActionTypeId {
        Version = "1",
        Category = "Test",
        Owner = "Custom",
        Provider = "MyJenkinsProviderName"
    },
    MaxBatchSize = 5,
    QueryParam = new Dictionary {
        { "ProjectName", "MyJenkinsTestProj" }
    }
});

List jobs = response.Jobs;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms