import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CodePipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodePipelineClient"; import type { CreatePipelineInput, CreatePipelineOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreatePipelineCommand}. */ export interface CreatePipelineCommandInput extends CreatePipelineInput { } /** * @public * * The output of {@link CreatePipelineCommand}. */ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __MetadataBearer { } declare const CreatePipelineCommand_base: { new (input: CreatePipelineCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: CreatePipelineCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Creates a pipeline.

* *

In the pipeline structure, you must include either artifactStore * or artifactStores in your pipeline, but you cannot use both. If you * create a cross-region action in your pipeline, you must use * artifactStores.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CodePipelineClient, CreatePipelineCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import * // const { CodePipelineClient, CreatePipelineCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import * // import type { CodePipelineClientConfig } from "@aws-sdk/client-codepipeline"; * const config = {}; // type is CodePipelineClientConfig * const client = new CodePipelineClient(config); * const input = { // CreatePipelineInput * 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 * "": { * 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" || "Compute", // required * owner: "AWS" || "ThirdParty" || "Custom", // required * provider: "STRING_VALUE", // required * version: "STRING_VALUE", // required * }, * runOrder: Number("int"), * configuration: { // ActionConfigurationMap * "": "STRING_VALUE", * }, * commands: [ // CommandList * "STRING_VALUE", * ], * outputArtifacts: [ // OutputArtifactList * { // OutputArtifact * name: "STRING_VALUE", // required * files: [ // FilePathList * "STRING_VALUE", * ], * }, * ], * inputArtifacts: [ // InputArtifactList * { // InputArtifact * name: "STRING_VALUE", // required * }, * ], * outputVariables: [ // OutputVariableList * "STRING_VALUE", * ], * roleArn: "STRING_VALUE", * region: "STRING_VALUE", * namespace: "STRING_VALUE", * timeoutInMinutes: Number("int"), * environmentVariables: [ // EnvironmentVariableList * { // EnvironmentVariable * name: "STRING_VALUE", // required * value: "STRING_VALUE", // required * type: "PLAINTEXT" || "SECRETS_MANAGER", * }, * ], * }, * ], * onFailure: { // FailureConditions * result: "ROLLBACK" || "FAIL" || "RETRY" || "SKIP", * retryConfiguration: { // RetryConfiguration * retryMode: "FAILED_ACTIONS" || "ALL_ACTIONS", * }, * conditions: [ // ConditionList * { // Condition * result: "ROLLBACK" || "FAIL" || "RETRY" || "SKIP", * rules: [ // RuleDeclarationList * { // RuleDeclaration * name: "STRING_VALUE", // required * ruleTypeId: { // RuleTypeId * category: "Rule", // required * owner: "AWS", * provider: "STRING_VALUE", // required * version: "STRING_VALUE", * }, * configuration: { // RuleConfigurationMap * "": "STRING_VALUE", * }, * commands: [ * "STRING_VALUE", * ], * inputArtifacts: [ * { * name: "STRING_VALUE", // required * }, * ], * roleArn: "STRING_VALUE", * region: "STRING_VALUE", * timeoutInMinutes: Number("int"), * }, * ], * }, * ], * }, * onSuccess: { // SuccessConditions * conditions: [ // required * { * result: "ROLLBACK" || "FAIL" || "RETRY" || "SKIP", * rules: [ * { * name: "STRING_VALUE", // required * ruleTypeId: { * category: "Rule", // required * owner: "AWS", * provider: "STRING_VALUE", // required * version: "STRING_VALUE", * }, * configuration: { * "": "STRING_VALUE", * }, * commands: [ * "STRING_VALUE", * ], * inputArtifacts: [ * { * name: "STRING_VALUE", // required * }, * ], * roleArn: "STRING_VALUE", * region: "STRING_VALUE", * timeoutInMinutes: Number("int"), * }, * ], * }, * ], * }, * beforeEntry: { // BeforeEntryConditions * conditions: [ // required * { * result: "ROLLBACK" || "FAIL" || "RETRY" || "SKIP", * rules: [ * { * name: "STRING_VALUE", // required * ruleTypeId: { * category: "Rule", // required * owner: "AWS", * provider: "STRING_VALUE", // required * version: "STRING_VALUE", * }, * configuration: { * "": "STRING_VALUE", * }, * commands: [ * "STRING_VALUE", * ], * inputArtifacts: [ * { * name: "STRING_VALUE", // required * }, * ], * roleArn: "STRING_VALUE", * region: "STRING_VALUE", * timeoutInMinutes: Number("int"), * }, * ], * }, * ], * }, * }, * ], * version: Number("int"), * executionMode: "QUEUED" || "SUPERSEDED" || "PARALLEL", * pipelineType: "V1" || "V2", * variables: [ // PipelineVariableDeclarationList * { // PipelineVariableDeclaration * name: "STRING_VALUE", // required * defaultValue: "STRING_VALUE", * description: "STRING_VALUE", * }, * ], * triggers: [ // PipelineTriggerDeclarationList * { // PipelineTriggerDeclaration * providerType: "CodeStarSourceConnection", // required * gitConfiguration: { // GitConfiguration * sourceActionName: "STRING_VALUE", // required * push: [ // GitPushFilterList * { // GitPushFilter * tags: { // GitTagFilterCriteria * includes: [ // GitTagPatternList * "STRING_VALUE", * ], * excludes: [ * "STRING_VALUE", * ], * }, * branches: { // GitBranchFilterCriteria * includes: [ // GitBranchPatternList * "STRING_VALUE", * ], * excludes: [ * "STRING_VALUE", * ], * }, * filePaths: { // GitFilePathFilterCriteria * includes: [ // GitFilePathPatternList * "STRING_VALUE", * ], * excludes: [ * "STRING_VALUE", * ], * }, * }, * ], * pullRequest: [ // GitPullRequestFilterList * { // GitPullRequestFilter * events: [ // GitPullRequestEventTypeList * "OPEN" || "UPDATED" || "CLOSED", * ], * branches: { * includes: [ * "STRING_VALUE", * ], * excludes: [ * "STRING_VALUE", * ], * }, * filePaths: { * includes: [ * "STRING_VALUE", * ], * excludes: [ * "STRING_VALUE", * ], * }, * }, * ], * }, * }, * ], * }, * tags: [ // TagList * { // Tag * key: "STRING_VALUE", // required * value: "STRING_VALUE", // required * }, * ], * }; * const command = new CreatePipelineCommand(input); * const response = await client.send(command); * // { // CreatePipelineOutput * // 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 * // "": { * // 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" || "Compute", // required * // owner: "AWS" || "ThirdParty" || "Custom", // required * // provider: "STRING_VALUE", // required * // version: "STRING_VALUE", // required * // }, * // runOrder: Number("int"), * // configuration: { // ActionConfigurationMap * // "": "STRING_VALUE", * // }, * // commands: [ // CommandList * // "STRING_VALUE", * // ], * // outputArtifacts: [ // OutputArtifactList * // { // OutputArtifact * // name: "STRING_VALUE", // required * // files: [ // FilePathList * // "STRING_VALUE", * // ], * // }, * // ], * // inputArtifacts: [ // InputArtifactList * // { // InputArtifact * // name: "STRING_VALUE", // required * // }, * // ], * // outputVariables: [ // OutputVariableList * // "STRING_VALUE", * // ], * // roleArn: "STRING_VALUE", * // region: "STRING_VALUE", * // namespace: "STRING_VALUE", * // timeoutInMinutes: Number("int"), * // environmentVariables: [ // EnvironmentVariableList * // { // EnvironmentVariable * // name: "STRING_VALUE", // required * // value: "STRING_VALUE", // required * // type: "PLAINTEXT" || "SECRETS_MANAGER", * // }, * // ], * // }, * // ], * // onFailure: { // FailureConditions * // result: "ROLLBACK" || "FAIL" || "RETRY" || "SKIP", * // retryConfiguration: { // RetryConfiguration * // retryMode: "FAILED_ACTIONS" || "ALL_ACTIONS", * // }, * // conditions: [ // ConditionList * // { // Condition * // result: "ROLLBACK" || "FAIL" || "RETRY" || "SKIP", * // rules: [ // RuleDeclarationList * // { // RuleDeclaration * // name: "STRING_VALUE", // required * // ruleTypeId: { // RuleTypeId * // category: "Rule", // required * // owner: "AWS", * // provider: "STRING_VALUE", // required * // version: "STRING_VALUE", * // }, * // configuration: { // RuleConfigurationMap * // "": "STRING_VALUE", * // }, * // commands: [ * // "STRING_VALUE", * // ], * // inputArtifacts: [ * // { * // name: "STRING_VALUE", // required * // }, * // ], * // roleArn: "STRING_VALUE", * // region: "STRING_VALUE", * // timeoutInMinutes: Number("int"), * // }, * // ], * // }, * // ], * // }, * // onSuccess: { // SuccessConditions * // conditions: [ // required * // { * // result: "ROLLBACK" || "FAIL" || "RETRY" || "SKIP", * // rules: [ * // { * // name: "STRING_VALUE", // required * // ruleTypeId: { * // category: "Rule", // required * // owner: "AWS", * // provider: "STRING_VALUE", // required * // version: "STRING_VALUE", * // }, * // configuration: { * // "": "STRING_VALUE", * // }, * // commands: [ * // "STRING_VALUE", * // ], * // inputArtifacts: [ * // { * // name: "STRING_VALUE", // required * // }, * // ], * // roleArn: "STRING_VALUE", * // region: "STRING_VALUE", * // timeoutInMinutes: Number("int"), * // }, * // ], * // }, * // ], * // }, * // beforeEntry: { // BeforeEntryConditions * // conditions: [ // required * // { * // result: "ROLLBACK" || "FAIL" || "RETRY" || "SKIP", * // rules: [ * // { * // name: "STRING_VALUE", // required * // ruleTypeId: { * // category: "Rule", // required * // owner: "AWS", * // provider: "STRING_VALUE", // required * // version: "STRING_VALUE", * // }, * // configuration: { * // "": "STRING_VALUE", * // }, * // commands: [ * // "STRING_VALUE", * // ], * // inputArtifacts: [ * // { * // name: "STRING_VALUE", // required * // }, * // ], * // roleArn: "STRING_VALUE", * // region: "STRING_VALUE", * // timeoutInMinutes: Number("int"), * // }, * // ], * // }, * // ], * // }, * // }, * // ], * // version: Number("int"), * // executionMode: "QUEUED" || "SUPERSEDED" || "PARALLEL", * // pipelineType: "V1" || "V2", * // variables: [ // PipelineVariableDeclarationList * // { // PipelineVariableDeclaration * // name: "STRING_VALUE", // required * // defaultValue: "STRING_VALUE", * // description: "STRING_VALUE", * // }, * // ], * // triggers: [ // PipelineTriggerDeclarationList * // { // PipelineTriggerDeclaration * // providerType: "CodeStarSourceConnection", // required * // gitConfiguration: { // GitConfiguration * // sourceActionName: "STRING_VALUE", // required * // push: [ // GitPushFilterList * // { // GitPushFilter * // tags: { // GitTagFilterCriteria * // includes: [ // GitTagPatternList * // "STRING_VALUE", * // ], * // excludes: [ * // "STRING_VALUE", * // ], * // }, * // branches: { // GitBranchFilterCriteria * // includes: [ // GitBranchPatternList * // "STRING_VALUE", * // ], * // excludes: [ * // "STRING_VALUE", * // ], * // }, * // filePaths: { // GitFilePathFilterCriteria * // includes: [ // GitFilePathPatternList * // "STRING_VALUE", * // ], * // excludes: [ * // "STRING_VALUE", * // ], * // }, * // }, * // ], * // pullRequest: [ // GitPullRequestFilterList * // { // GitPullRequestFilter * // events: [ // GitPullRequestEventTypeList * // "OPEN" || "UPDATED" || "CLOSED", * // ], * // branches: { * // includes: [ * // "STRING_VALUE", * // ], * // excludes: [ * // "STRING_VALUE", * // ], * // }, * // filePaths: { * // includes: [ * // "STRING_VALUE", * // ], * // excludes: [ * // "STRING_VALUE", * // ], * // }, * // }, * // ], * // }, * // }, * // ], * // }, * // tags: [ // TagList * // { // Tag * // key: "STRING_VALUE", // required * // value: "STRING_VALUE", // required * // }, * // ], * // }; * * ``` * * @param CreatePipelineCommandInput - {@link CreatePipelineCommandInput} * @returns {@link CreatePipelineCommandOutput} * @see {@link CreatePipelineCommandInput} for command's `input` shape. * @see {@link CreatePipelineCommandOutput} for command's `response` shape. * @see {@link CodePipelineClientResolvedConfig | config} for CodePipelineClient's `config` shape. * * @throws {@link ConcurrentModificationException} (client fault) *

Unable to modify the tag due to a simultaneous update request.

* * @throws {@link InvalidActionDeclarationException} (client fault) *

The action declaration was specified in an invalid format.

* * @throws {@link InvalidBlockerDeclarationException} (client fault) *

Reserved for future use.

* * @throws {@link InvalidStageDeclarationException} (client fault) *

The stage declaration was specified in an invalid format.

* * @throws {@link InvalidStructureException} (client fault) *

The structure was specified in an invalid format.

* * @throws {@link InvalidTagsException} (client fault) *

The specified resource tags are invalid.

* * @throws {@link LimitExceededException} (client fault) *

The number of pipelines associated with the Amazon Web Services account has exceeded * the limit allowed for the account.

* * @throws {@link PipelineNameInUseException} (client fault) *

The specified pipeline name is already in use.

* * @throws {@link TooManyTagsException} (client fault) *

The tags limit for a resource has been exceeded.

* * @throws {@link ValidationException} (client fault) *

The validation was specified in an invalid format.

* * @throws {@link CodePipelineServiceException} *

Base exception class for all service exceptions from CodePipeline service.

* * * @public */ export declare class CreatePipelineCommand extends CreatePipelineCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreatePipelineInput; output: CreatePipelineOutput; }; sdk: { input: CreatePipelineCommandInput; output: CreatePipelineCommandOutput; }; }; }