Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class PollForThirdPartyJobsCommandProtected

Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { CodePipelineClient, PollForThirdPartyJobsCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import
// const { CodePipelineClient, PollForThirdPartyJobsCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import
const client = new CodePipelineClient(config);
const input = { // PollForThirdPartyJobsInput
actionTypeId: { // ActionTypeId
category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
owner: "AWS" || "ThirdParty" || "Custom", // required
provider: "STRING_VALUE", // required
version: "STRING_VALUE", // required
},
maxBatchSize: Number("int"),
};
const command = new PollForThirdPartyJobsCommand(input);
const response = await client.send(command);
// { // PollForThirdPartyJobsOutput
// jobs: [ // ThirdPartyJobList
// { // ThirdPartyJob
// clientId: "STRING_VALUE",
// jobId: "STRING_VALUE",
// },
// ],
// };

Param

PollForThirdPartyJobsCommandInput

Returns

PollForThirdPartyJobsCommandOutput

See

Throws

ActionTypeNotFoundException (client fault)

The specified action type cannot be found.

Throws

ValidationException (client fault)

The validation was specified in an invalid format.

Throws

CodePipelineServiceException

Base exception class for all service exceptions from CodePipeline service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods