@aws-sdk/client-codepipeline 3.337.0 → 3.340.0

package/dist-types/commands/UpdateActionTypeCommand.d.ts

@@ -3,6 +3,10 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { CodePipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodePipelineClient";
 import { UpdateActionTypeInput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
 /**
  * @public
  *
@@ -46,12 +50,12 @@ export interface UpdateActionTypeCommandOutput extends __MetadataBearer {
  *           ],
  *         },
  *       },
- *       type: "STRING_VALUE", // required
+ *       type: "JobWorker" || "Lambda", // required
  *       policyStatementsTemplate: "STRING_VALUE",
  *       jobTimeout: Number("int"),
  *     },
  *     id: { // ActionTypeIdentifier
- *       category: "STRING_VALUE", // required
+ *       category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
  *       owner: "STRING_VALUE", // required
  *       provider: "STRING_VALUE", // required
  *       version: "STRING_VALUE", // required

package/dist-types/commands/UpdatePipelineCommand.d.ts

@@ -3,6 +3,10 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { CodePipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodePipelineClient";
 import { UpdatePipelineInput, UpdatePipelineOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
 /**
  * @public
  *
@@ -34,20 +38,20 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineOutput, __Met
  *     name: "STRING_VALUE", // required
  *     roleArn: "STRING_VALUE", // required
  *     artifactStore: { // ArtifactStore
- *       type: "STRING_VALUE", // required
+ *       type: "S3", // required
  *       location: "STRING_VALUE", // required
  *       encryptionKey: { // EncryptionKey
  *         id: "STRING_VALUE", // required
- *         type: "STRING_VALUE", // required
+ *         type: "KMS", // required
  *       },
  *     },
  *     artifactStores: { // ArtifactStoreMap
  *       "<keys>": {
- *         type: "STRING_VALUE", // required
+ *         type: "S3", // required
  *         location: "STRING_VALUE", // required
  *         encryptionKey: {
  *           id: "STRING_VALUE", // required
- *           type: "STRING_VALUE", // required
+ *           type: "KMS", // required
  *         },
  *       },
  *     },
@@ -57,15 +61,15 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineOutput, __Met
  *         blockers: [ // StageBlockerDeclarationList
  *           { // BlockerDeclaration
  *             name: "STRING_VALUE", // required
- *             type: "STRING_VALUE", // required
+ *             type: "Schedule", // required
  *           },
  *         ],
  *         actions: [ // StageActionDeclarationList // required
  *           { // ActionDeclaration
  *             name: "STRING_VALUE", // required
  *             actionTypeId: { // ActionTypeId
- *               category: "STRING_VALUE", // required
- *               owner: "STRING_VALUE", // required
+ *               category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
+ *               owner: "AWS" || "ThirdParty" || "Custom", // required
  *               provider: "STRING_VALUE", // required
  *               version: "STRING_VALUE", // required
  *             },
@@ -100,20 +104,20 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineOutput, __Met
  * //     name: "STRING_VALUE", // required
  * //     roleArn: "STRING_VALUE", // required
  * //     artifactStore: { // ArtifactStore
- * //       type: "STRING_VALUE", // required
+ * //       type: "S3", // required
  * //       location: "STRING_VALUE", // required
  * //       encryptionKey: { // EncryptionKey
  * //         id: "STRING_VALUE", // required
- * //         type: "STRING_VALUE", // required
+ * //         type: "KMS", // required
  * //       },
  * //     },
  * //     artifactStores: { // ArtifactStoreMap
  * //       "<keys>": {
- * //         type: "STRING_VALUE", // required
+ * //         type: "S3", // required
  * //         location: "STRING_VALUE", // required
  * //         encryptionKey: {
  * //           id: "STRING_VALUE", // required
- * //           type: "STRING_VALUE", // required
+ * //           type: "KMS", // required
  * //         },
  * //       },
  * //     },
@@ -123,15 +127,15 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineOutput, __Met
  * //         blockers: [ // StageBlockerDeclarationList
  * //           { // BlockerDeclaration
  * //             name: "STRING_VALUE", // required
- * //             type: "STRING_VALUE", // required
+ * //             type: "Schedule", // required
  * //           },
  * //         ],
  * //         actions: [ // StageActionDeclarationList // required
  * //           { // ActionDeclaration
  * //             name: "STRING_VALUE", // required
  * //             actionTypeId: { // ActionTypeId
- * //               category: "STRING_VALUE", // required
- * //               owner: "STRING_VALUE", // required
+ * //               category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
+ * //               owner: "AWS" || "ThirdParty" || "Custom", // required
  * //               provider: "STRING_VALUE", // required
  * //               version: "STRING_VALUE", // required
  * //             },
@@ -181,8 +185,8 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineOutput, __Met
  *  <p>The structure was specified in an invalid format.</p>
  *
  * @throws {@link LimitExceededException} (client fault)
- *  <p>The number of pipelines associated with the AWS account has exceeded the limit
- *             allowed for the account.</p>
+ *  <p>The number of pipelines associated with the Amazon Web Services account has exceeded
+ *             the limit allowed for the account.</p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>The validation was specified in an invalid format.</p>

package/dist-types/index.d.ts

@@ -1,6 +1,204 @@
-export * from "./CodePipeline";
+/**
+ * <fullname>CodePipeline</fullname>
+ *          <p>
+ *             <b>Overview</b>
+ *          </p>
+ *          <p>This is the CodePipeline API Reference. This guide provides descriptions
+ *             of the actions and data types for CodePipeline. Some functionality for your
+ *             pipeline can only be configured through the API. For more information, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html">CodePipeline User Guide</a>.</p>
+ *          <p>You can use the CodePipeline API to work with pipelines, stages, actions,
+ *             and transitions.</p>
+ *          <p>
+ *             <i>Pipelines</i> are models of automated release processes. Each pipeline
+ *             is uniquely named, and consists of stages, actions, and transitions. </p>
+ *          <p>You can work with pipelines by calling:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a>CreatePipeline</a>, which creates a uniquely named
+ *                     pipeline.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>DeletePipeline</a>, which deletes the specified
+ *                     pipeline.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>GetPipeline</a>, which returns information about the pipeline
+ *                     structure and pipeline metadata, including the pipeline Amazon Resource Name
+ *                     (ARN).</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>GetPipelineExecution</a>, which returns information about a
+ *                     specific execution of a pipeline.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>GetPipelineState</a>, which returns information about the current
+ *                     state of the stages and actions of a pipeline.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>ListActionExecutions</a>, which returns action-level details
+ *                     for past executions. The details include full stage and action-level details,
+ *                     including individual action duration, status, any errors that occurred during
+ *                     the execution, and input and output artifact location details.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>ListPipelines</a>, which gets a summary of all of the pipelines
+ *                     associated with your account.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>ListPipelineExecutions</a>, which gets a summary of the most
+ *                     recent executions for a pipeline.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>StartPipelineExecution</a>, which runs the most recent revision of
+ *                     an artifact through the pipeline.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>StopPipelineExecution</a>, which stops the specified pipeline
+ *                     execution from continuing through the pipeline.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>UpdatePipeline</a>, which updates a pipeline with edits or changes
+ *                     to the structure of the pipeline.</p>
+ *             </li>
+ *          </ul>
+ *          <p>Pipelines include <i>stages</i>. Each stage contains one or more
+ *             actions that must complete before the next stage begins. A stage results in success or
+ *             failure. If a stage fails, the pipeline stops at that stage and remains stopped until
+ *             either a new version of an artifact appears in the source location, or a user takes
+ *             action to rerun the most recent artifact through the pipeline. You can call <a>GetPipelineState</a>, which displays the status of a pipeline, including the
+ *             status of stages in the pipeline, or <a>GetPipeline</a>, which returns the
+ *             entire structure of the pipeline, including the stages of that pipeline. For more
+ *             information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">CodePipeline
+ *                 Pipeline Structure Reference</a>.</p>
+ *          <p>Pipeline stages include <i>actions</i> that are categorized into
+ *             categories such as source or build actions performed in a stage of a pipeline. For
+ *             example, you can use a source action to import artifacts into a pipeline from a source
+ *             such as Amazon S3. Like stages, you do not work with actions directly in most cases, but
+ *             you do define and interact with actions when working with pipeline operations such as
+ *                 <a>CreatePipeline</a> and <a>GetPipelineState</a>. Valid
+ *             action categories are:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Source</p>
+ *             </li>
+ *             <li>
+ *                <p>Build</p>
+ *             </li>
+ *             <li>
+ *                <p>Test</p>
+ *             </li>
+ *             <li>
+ *                <p>Deploy</p>
+ *             </li>
+ *             <li>
+ *                <p>Approval</p>
+ *             </li>
+ *             <li>
+ *                <p>Invoke</p>
+ *             </li>
+ *          </ul>
+ *          <p>Pipelines also include <i>transitions</i>, which allow the transition
+ *             of artifacts from one stage to the next in a pipeline after the actions in one stage
+ *             complete.</p>
+ *          <p>You can work with transitions by calling:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a>DisableStageTransition</a>, which prevents artifacts from
+ *                     transitioning to the next stage in a pipeline.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>EnableStageTransition</a>, which enables transition of artifacts
+ *                     between stages in a pipeline. </p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <b>Using the API to integrate with CodePipeline</b>
+ *          </p>
+ *          <p>For third-party integrators or developers who want to create their own integrations
+ *             with CodePipeline, the expected sequence varies from the standard API user. To
+ *             integrate with CodePipeline, developers need to work with the following
+ *             items:</p>
+ *          <p>
+ *             <b>Jobs</b>, which are instances of an action. For
+ *             example, a job for a source action might import a revision of an artifact from a source. </p>
+ *          <p>You can work with jobs by calling:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a>AcknowledgeJob</a>, which confirms whether a job worker has
+ *                     received the specified job.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>GetJobDetails</a>, which returns the details of a job.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>PollForJobs</a>, which determines whether there are any jobs to
+ *                     act on.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>PutJobFailureResult</a>, which provides details of a job failure.
+ *                 </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>PutJobSuccessResult</a>, which provides details of a job
+ *                     success.</p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <b>Third party jobs</b>, which are instances of an action
+ *             created by a partner action and integrated into CodePipeline. Partner actions are
+ *             created by members of the Amazon Web Services Partner Network.</p>
+ *          <p>You can work with third party jobs by calling:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker
+ *                     has received the specified job.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>GetThirdPartyJobDetails</a>, which requests the details of a job
+ *                     for a partner action.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>PollForThirdPartyJobs</a>, which determines whether there are any
+ *                     jobs to act on. </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>PutThirdPartyJobFailureResult</a>, which provides details of a job
+ *                     failure.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job
+ *                     success.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @packageDocumentation
+ */
 export * from "./CodePipelineClient";
+export * from "./CodePipeline";
 export * from "./commands";
-export * from "./models";
 export * from "./pagination";
+export * from "./models";
 export { CodePipelineServiceException } from "./models/CodePipelineServiceException";

package/dist-types/models/CodePipelineServiceException.d.ts

@@ -1,4 +1,5 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
+export { __ServiceException, __ServiceExceptionOptions };
 /**
  * @public
  *