Class GetThirdPartyJobDetailsCommandProtected

Requests the details of a job for a third party action. 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. 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, GetThirdPartyJobDetailsCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import
// const { CodePipelineClient, GetThirdPartyJobDetailsCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import
const client = new CodePipelineClient(config);
const input = { // GetThirdPartyJobDetailsInput
  jobId: "STRING_VALUE", // required
  clientToken: "STRING_VALUE", // required
};
const command = new GetThirdPartyJobDetailsCommand(input);
const response = await client.send(command);
// { // GetThirdPartyJobDetailsOutput
//   jobDetails: { // ThirdPartyJobDetails
//     id: "STRING_VALUE",
//     data: { // ThirdPartyJobData
//       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",
//   },
// };

Param

GetThirdPartyJobDetailsCommandInput

Returns

GetThirdPartyJobDetailsCommandOutput

See

• GetThirdPartyJobDetailsCommandInput for command's input shape.
• GetThirdPartyJobDetailsCommandOutput for command's response shape.
• config for CodePipelineClient's config shape.

Throws

InvalidClientTokenException (client fault)

The client token was specified in an invalid format

Throws

InvalidJobException (client fault)

The job was specified in an invalid format or cannot be found.

Throws

JobNotFoundException (client fault)

The job was specified in an invalid format or 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.