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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to PollForJobsAsync.

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

Syntax

C#
public virtual PollForJobsResponse PollForJobs(
         PollForJobsRequest request
)
Parameters
request
Type: Amazon.CodePipeline.Model.PollForJobsRequest

Container for the necessary parameters to execute the PollForJobs service method.

Return Value
The response from the PollForJobs service method, as returned by CodePipeline.

Exceptions

ExceptionCondition
ActionTypeNotFoundException The specified action type cannot be found.
ValidationException The validation was specified in an invalid format.

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

See Also