Class PollForJobsCommandProtected

Returns information about any jobs for 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, 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.

Example

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

import { CodePipelineClient, PollForJobsCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import
// const { CodePipelineClient, PollForJobsCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import
const client = new CodePipelineClient(config);
const input = { // PollForJobsInput
  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"),
  queryParam: { // QueryParamMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new PollForJobsCommand(input);
const response = await client.send(command);
// { // PollForJobsOutput
//   jobs: [ // JobList
//     { // Job
//       id: "STRING_VALUE",
//       data: { // JobData
//         actionTypeId: { // ActionTypeId
//           category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
//           owner: "AWS" || "ThirdParty" || "Custom", // required
//           provider: "STRING_VALUE", // required
//           version: "STRING_VALUE", // required
//         },
//         actionConfiguration: { // ActionConfiguration
//           configuration: { // ActionConfigurationMap
//             "<keys>": "STRING_VALUE",
//           },
//         },
//         pipelineContext: { // PipelineContext
//           pipelineName: "STRING_VALUE",
//           stage: { // StageContext
//             name: "STRING_VALUE",
//           },
//           action: { // ActionContext
//             name: "STRING_VALUE",
//             actionExecutionId: "STRING_VALUE",
//           },
//           pipelineArn: "STRING_VALUE",
//           pipelineExecutionId: "STRING_VALUE",
//         },
//         inputArtifacts: [ // ArtifactList
//           { // Artifact
//             name: "STRING_VALUE",
//             revision: "STRING_VALUE",
//             location: { // ArtifactLocation
//               type: "S3",
//               s3Location: { // S3ArtifactLocation
//                 bucketName: "STRING_VALUE", // required
//                 objectKey: "STRING_VALUE", // required
//               },
//             },
//           },
//         ],
//         outputArtifacts: [
//           {
//             name: "STRING_VALUE",
//             revision: "STRING_VALUE",
//             location: {
//               type: "S3",
//               s3Location: {
//                 bucketName: "STRING_VALUE", // required
//                 objectKey: "STRING_VALUE", // required
//               },
//             },
//           },
//         ],
//         artifactCredentials: { // AWSSessionCredentials
//           accessKeyId: "STRING_VALUE", // required
//           secretAccessKey: "STRING_VALUE", // required
//           sessionToken: "STRING_VALUE", // required
//         },
//         continuationToken: "STRING_VALUE",
//         encryptionKey: { // EncryptionKey
//           id: "STRING_VALUE", // required
//           type: "KMS", // required
//         },
//       },
//       nonce: "STRING_VALUE",
//       accountId: "STRING_VALUE",
//     },
//   ],
// };

Param

PollForJobsCommandInput

Returns

PollForJobsCommandOutput

See

• PollForJobsCommandInput for command's input shape.
• PollForJobsCommandOutput for command's response shape.
• config for CodePipelineClient's config shape.

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.