@aws- sdk/ 客户端编码管道

说明

JavaScript CodePipeline 客户端的 AWS SDK 为 Node.js, 浏览器和React Introduct 的 AWS SDK .

概览

这是代码Pipeline API参考。 本指南提供描述 的动作和数据类型。 您的一些功能 管道只能通过 API 配置 。 更多信息,请参见 代码管道用户指南。 。 。 .

您可以使用 CodePipeline API 与管道,阶段,动作, 和过渡.

管道 是自动发布进程的模型。 每个管道 由各个阶段、行动和过渡组成.

您可通过下列方式与管道合作:

• 创建管道,它创造了一个独特的名称 输油管.

• 删除管道,删除指定的 输油管.

• 获取管道,返回关于管道的信息 结构和管道元数据,包括管道亚马逊资源名称 (韩文).

• 获取 Pipeline 执行,返回关于 a 具体执行管道.

• 获取管道状态,返回当前信息 管道的阶段和行动状况.

• 列表动作执行,返回动作级别细节 对于过去的处决。 细节包括整个阶段和行动层面的细节, 包括个人行动的持续时间、状态、在 以及输入和输出的文物位置细节.

• 列表符号,它得到了所有管道的概要 和你的账户有关.

• 列表 Pipeline 执行,它得到一个最摘要 最近为了输油管被处决.

• 启动 Pipeline 执行,它运行最近对 一个通过管道的文物.

• 停止 Pipeline 执行,停止指定的管道 继续通过管道执行.

• 更新管道,用于更新带有编辑或修改的管道 到管道的结构.

管道包括: 阶段。每个阶段包含一个或多个 在下一阶段开始前必须完成的行动。 阶段导致成功或 失败。 如果一个阶段失败,输油管在那个阶段停止,直到 文物的新版本出现在源位置,或者用户使用 通过管道重新管理最新文物的行动。 你可以打电话 获取管道状态,显示管道状态,包括 管道阶段的状况,或 获取管道,返回 管道的整个结构,包括管道的各个阶段。 为了更多 关于阶段和行动结构的信息,见 代码平线 管道结构参考。 。 。 .

管道阶段包括: 动作 分类 类别,如来源或构建在管道阶段采取的行动。 对于 例如,您可以使用源代码动作从源代码导入到管道中 例如亚马逊S3. 和阶段一样,大多数情况下你并不直接与行动合作,但 您在进行管道操作时确实定义了动作并与之互动,例如: 创建管道 财务报告和审定财务报表 获取管道状态有效性 动作类别为:

• 来源

• 构建

• 测试

• 部署

• 核准

• 调用

• 计算

管道还包括: 过渡,允许过渡 在一个阶段行动后,从一个阶段到另一个阶段的 完成 。 .

您可通过调用 :

• 禁用变换,防止文物 在管道中向下一阶段过渡.

• 启用Stage 转换,可以使文物过渡 在管道的各阶段之间.

使用 API 与 CodePipeline 集成

对想要创建自己集成的第三方集成商或开发商而言 与 CodePipeline 相通,预期序列与标准API 用户不同. 改为: 与 CodePipeline 集成, 开发人员需要与以下程序合作 项目:

工作,这些是行动的例子。 对于 例如,为源头行动进行的工作可能会从源头进口对文物的修订.

您可通过拨打下列电话进行工作:

• 承认职务,这证实了一个工人是否有 获得指定的任务.

• 获取工作详情,返回工作的细节.

• PollForJobs (英语),决定是否有工作可以 继续.

• PutJob 失败结果,它提供了工作失败的细节.

• PutJob 成功结果,提供了工作的细节 成功吗.

第三方工作,是行为实例 由伙伴行动创建并被整合入CodePipeline. 合作伙伴的行动是: 由亚马逊网络服务伙伴网络成员创建.

您可拨打下列电话从事第三方工作:

• 承认第三方,这证实了是否一个工人 已经收到指定的任务.

• 获取第三方工作详情,它要求详细的工作 为伙伴行动.

• 第三方作业,以确定是否有 工作可以继续.

• 启动第三方工作失败结果,提供了工作的细节 失败.

• 将第三方接续成功,提供了工作的细节 成功吗.

安装

要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :

• npm install @aws-sdk/client-codepipeline
• yarn add @aws-sdk/client-codepipeline
• pnpm add @aws-sdk/client-codepipeline

开始

导入

AWS SDK由客户端和命令进行调制. 要发送请求,只需导入 CodePipelineClient 财务报告和审定财务报表 例如,您需要的命令 ListActionTypesCommand数字 :

// ES5 example
const { CodePipelineClient, ListActionTypesCommand } = require("@aws-sdk/client-codepipeline");

// ES6+ example
import { CodePipelineClient, ListActionTypesCommand } from "@aws-sdk/client-codepipeline";

使用量

发出请求:

• 以配置(如证书,区域)为客户端提供证据.
  • 见 文件/中心 用于配置细节.
  • 见 @aws- sdk/ 配置 附加选项.
• 以输入参数证明命令 .
• 打电话 send 操作客户端,以输入方式提供命令对象.

const client = new CodePipelineClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListActionTypesCommand(params);

自动/等待

我们建议使用 等待时 运算符等待通过发送操作返回的承诺如下:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

承诺

您还可以使用 承诺连锁。 。 。 .

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

合并客户端

归集客户端类别从同套件中导出,但没有"Client"后缀.

CodePipeline 扩展 CodePipelineClient 并额外支持所有操作,服务员, 和活人作为方法. 这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.

如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(CodePipelineClient) (中文(简体) ). 更多详情见博客文章: javaScript 的 AWS SDK 模块包。 。 。 .

import { CodePipeline } from "@aws-sdk/client-codepipeline";

const client = new CodePipeline({ region: "REGION" });

// async/await.
try {
  const data = await client.listActionTypes(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listActionTypes(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listActionTypes(params, (err, data) => {
  // process err and data.
});

解决问题

当服务返回例外时,错误将包括例外信息, 以及响应元数据(如请求编号).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

另见 文档/错误。 。 。 .

获取帮助

请利用这些社区资源获得帮助. 我们使用 GitHub 问题来跟踪错误和特性请求,但处理它们的带宽有限.

• 访问 开发者指南 或者说 API 参考。 。 。 .
• 看看贴有标签的博客文章 aws-sdk-js aWS 开发者博客.
• 问个问题 叠叠流 并贴上标签 aws-sdk-js。 。 。 .
• 加入 AWS JavaScript 社区 发光。 。 。 .
• 如果你发现你发现了一个虫子,请 打开一个问题。 。 。 .

为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .

捐款

此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-codepipeline 软件包正在更新. 为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .

许可证

此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.

客户端命令( 操作列表)