Class GetPipelineCommandProtected

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.

Example

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

import { CodePipelineClient, GetPipelineCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import
// const { CodePipelineClient, GetPipelineCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import
const client = new CodePipelineClient(config);
const input = { // GetPipelineInput
  name: "STRING_VALUE", // required
  version: Number("int"),
};
const command = new GetPipelineCommand(input);
const response = await client.send(command);
// { // GetPipelineOutput
//   pipeline: { // PipelineDeclaration
//     name: "STRING_VALUE", // required
//     roleArn: "STRING_VALUE", // required
//     artifactStore: { // ArtifactStore
//       type: "S3", // required
//       location: "STRING_VALUE", // required
//       encryptionKey: { // EncryptionKey
//         id: "STRING_VALUE", // required
//         type: "KMS", // required
//       },
//     },
//     artifactStores: { // ArtifactStoreMap
//       "<keys>": {
//         type: "S3", // required
//         location: "STRING_VALUE", // required
//         encryptionKey: {
//           id: "STRING_VALUE", // required
//           type: "KMS", // required
//         },
//       },
//     },
//     stages: [ // PipelineStageDeclarationList // required
//       { // StageDeclaration
//         name: "STRING_VALUE", // required
//         blockers: [ // StageBlockerDeclarationList
//           { // BlockerDeclaration
//             name: "STRING_VALUE", // required
//             type: "Schedule", // required
//           },
//         ],
//         actions: [ // StageActionDeclarationList // required
//           { // ActionDeclaration
//             name: "STRING_VALUE", // required
//             actionTypeId: { // ActionTypeId
//               category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
//               owner: "AWS" || "ThirdParty" || "Custom", // required
//               provider: "STRING_VALUE", // required
//               version: "STRING_VALUE", // required
//             },
//             runOrder: Number("int"),
//             configuration: { // ActionConfigurationMap
//               "<keys>": "STRING_VALUE",
//             },
//             outputArtifacts: [ // OutputArtifactList
//               { // OutputArtifact
//                 name: "STRING_VALUE", // required
//               },
//             ],
//             inputArtifacts: [ // InputArtifactList
//               { // InputArtifact
//                 name: "STRING_VALUE", // required
//               },
//             ],
//             roleArn: "STRING_VALUE",
//             region: "STRING_VALUE",
//             namespace: "STRING_VALUE",
//           },
//         ],
//       },
//     ],
//     version: Number("int"),
//   },
//   metadata: { // PipelineMetadata
//     pipelineArn: "STRING_VALUE",
//     created: new Date("TIMESTAMP"),
//     updated: new Date("TIMESTAMP"),
//     pollingDisabledAt: new Date("TIMESTAMP"),
//   },
// };

Param

GetPipelineCommandInput

Returns

GetPipelineCommandOutput

See

• GetPipelineCommandInput for command's input shape.
• GetPipelineCommandOutput for command's response shape.
• config for CodePipelineClient's config shape.

Throws

PipelineNotFoundException (client fault)

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

Throws

PipelineVersionNotFoundException (client fault)

The pipeline version 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.