@aws- sdk/ 客户端编码承诺

说明

JavaScript CodeCommit 客户端的 AWS SDK 为Node.js 提供 AWS SDK, 浏览器和 React Industrial.

这是 代码承诺 API 引用的操作和数据类型 代码承诺 API 以及使用示例 .

您可以使用 CodeCommit API 来工作以下对象:

仓库,通过调用以下内容: 1

• 批次获取仓库,它返回与您的 Amazon Web 服务账户相关的一个或多个寄存器的信息.

• 创建仓库,它创建了代码承诺存储器.

• 删除仓库,删除代码承诺寄存器.

• 获取仓库,它返回关于指定寄存器的信息.

• 列表仓库,它列出了所有与您的 Amazon 网络服务账户相关的 CodeCommit 寄存器.

• 更新仓库描述,用于设置或更新寄存器的描述.

• 更新存储器键,用于更新所使用的密钥管理服务加密密钥 以加密和解密仓库.

• 更新仓库Name,修改名称 仓库。 如果您更改了寄存器的名称, 则没有其它用户 仓库可以访问它,直到您将新的 HTTPS 或 SSH URL 发送给它们 使用时.

分支,通过下列称呼:

• 创建框,在指定的 仓库.

• 删除宽度,删除寄存器中指定的分支,除非它是默认分支.

• 获取缓冲,它返回关于指定分支的信息.

• 列表宽度,其中列出了指定寄存器的所有分支.

• 更新,用于修改寄存器的默认分支.

文件,通过调用以下文件:

• 删除文件,从指定的分支中删除指定文件的内容.

• 获取布洛布,它返回一个 个人 存储器中的 Git blob 对象 .

• 获取 Blob 偏差,返回结构化的行级 diff 介于寄存器中两个 blob 版本之间, 周围可选 上下文线条.

• 获取文件,它返回指定文件的编码内容.

• 获取福德,返回指定文件夹或目录的内容.

• 列表文件承诺历史,可以获取一个任务列表和对指定文件的修改.

• 设置文件,在指定的寄存器和分支中添加或修改单个文件.

承诺:

• 批量获取承诺,返回关于一个或多个存储器的信息.

• 创建承诺,它为修改寄存器创建承诺.

• 获得承诺,以返回关于某项犯罪的信息,包括 信息和作者及承诺者信息.

• 获取偏差,返回关于 有效的承诺描述符(如分支、标记、头、承诺ID、, 或完全有保留的参考.

合并,通过下列称呼:

• 批量描述冲突,它返回关于存储器中承诺之间合并中冲突的信息.

• 创建未引用的重置承诺,从而在两个分支之间产生一种无参照的承诺,或为 目的是对它们进行比较并查明任何潜在的冲突.

• 描述主要冲突,它返回关于基础、源和目的版本之间合并冲突的信息 中的文件.

• 获取重力承诺,它返回关于源和目的之间合并的信息.

• 获取冲突,返回关于合并冲突的信息 在牵引请求中介于源和目的分支之间.

• 获取变量,它返回关于两个分支之间可用的合并选项的信息,或者承诺指定符.

• 合并BranchesBy快取,它使用快向合并选项合并了两个分支.

• 合并BySquash,它使用壁球合并选项将两个分支合并.

• 合并BranchesByTreeWay,它使用三向合并选项合并了两个分支.

调用请求,具体如下:

• 创建 Pull 请求,在指定的寄存器中创建拉动请求.

• 创建请求核准规则,这为特定的拉动请求创造了批准规则.

• 删除请求核准规则,删除对特定拉力请求的批准规则.

• 描述普尔请求事件,它返回关于一个或多个拉动请求事件的信息.

• 评价普尔请求核准规则,评估拉动请求是否符合其相关批准规则中规定的所有条件.

• 获取 CommentsForPull 请求,它返回关于特定拉动请求的注释信息.

• 获取 Pull 请求,它返回关于指定拉动请求的信息.

• 获得普尔请求批准国,它返回关于指定拉动请求的批准状态的信息.

• 获取 Pull 请求管理状态,其中返回关于批准规则是否被搁置(覆盖)的信息 拉请求,如果是的话,用户或身份的亚马逊资源名(ARN)会超越规则及其对拉请求的要求.

• 列表,其中列出了所有对寄存器的拖动请求.

• 合并 Pull 请求快速前进,将拉动请求的源目的分支合并到指定的目的地 使用快速前向合并选项为拉动请求创建分支.

• 合并 Pull 请求方块,将拉动请求的源目的分支合并到指定的目的地 使用 millet 合并选项为拉动请求创建分支 .

• 合并 Pull 请求By TreeWay,将拉动请求的源目的分支合并到指定的目的地 使用三向合并选项为拖动请求提供分支.

• 否决请求核准规则,它排除了所有关于拉动请求的批准规则要求.

• 帖子Comment ForPull 请求,在指定行、文件或请求中将注释发布到拉动请求.

• 更新 Pull 请求批准规则,它更新了拉力请求批准规则的结构.

• 更新普尔请求核准状态,它更新了对拉动请求的批准状态.

• 更新普尔请求描述,它更新了拉动请求的描述.

• 更新请求状态,它更新了拉动请求的状态.

• 更新 Pull 请求标题,它更新了拉动请求的标题.

核准规则模板,要求如下:

• 协理核准规则模板与仓库模板 带有指定的仓库。 在模板与寄存器连接后, 代码承诺创建匹配模板条件的审批规则 在指定的寄存器中创建的每个拖动请求 .

• 批量关联 批注规则模板与仓库,其中涉及 带有一个或多个指定寄存器的模板。 在模板之后 与寄存器相关联, CodeCommit 创建匹配的审批规则 指定中创建的每个拉动请求的模板条件 存储器.

• 批量解析程序 RulesTemplate from Reposities,删除 将模板与指定的存储库联系起来,以便制定批准规则 在拖动请求时, 模板不会自动创建 在那些仓库里创建的.

• 创建批准规则模板,它为批准规则创建了模板,然后可以与一个或多个寄存器连接 在您的 Amazon 网络服务账户中.

• 删除核准规则模板,删除指定的模板。 它不删除已经用模板创建的拉动请求的批准规则 .

• 取消对寄存处规则的核准,删除 将模板与存储库联系起来,以便根据 当拖动请求创建于 指定仓库.

• 获得核准规则模板,它返回关于批准规则模板的信息.

• 列表核准规则模板,它将亚马逊Web Services区域中的所有批准规则模板都列出在您的AmazonWeb Services账户中.

• ListAssociated Approvoral RultTemplates for propositorial 存档副本 存档副本,其中列出了所有与指定寄存器相关的批准规则模板.

• 核准规则模板的列表存储器,其中列出了与指定批准规则模板相关的所有寄存器.

• 更新对规则的核准,它更新了对一个 批准规则模板.

• 更新核准规则模板Name,它更新了批准规则模板的名称.

• 更新核准规则模板,它更新了批准规则模板的内容.

在一个存储处发表评论,称:

• 删除Comment 关联,删除对存储器中某项承诺的评论内容.

• 获取Comment,它返回关于对某项犯罪的评论的信息.

• 获取评论反应,它返回关于emoji反应的注释信息.

• 获取对比较承诺的评论,它返回关于两个承诺指定方之间比较的评论的信息 在仓库里.

• 后端Comment 用于比较承诺,从而对存储库中两个承诺指定者之间的比较形成评论.

• 邮递,从而形成对评论的答复.

• 放置评论反应,它创建或更新了对评论的emoji反应.

• 更新Comment,它更新了存储器中对承诺的评论内容.

用于在 CodeCommit (而不是 Git 标签) 中标记资源的标记, 使用如下调用 :

• 列表标签格式资源,它获得关于代码Commit中指定的亚马逊资源名称(ARN)的亚马逊网络服务tags的信息.

• 标签资源,用于添加或更新代码承诺中的资源标签.

• 调和资源,它将删除 CodeCommit中资源标记.

触发器,通过调用如下:

• 获取存储器,返回关于已配置的触发的信息 是一个仓库.

• 配置仓库,它取代了存储器的所有触发器,并且可以 用于创建或删除触发器.

• 测试仓库,测试仓库触发器的功能 将数据发送给触发目标.

关于如何使用 Code Committe 的信息,请参见 代码承诺用户指南。 。 。 .

安装

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

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

开始

导入

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

// ES5 example
const { CodeCommitClient, ListRepositoriesCommand } = require("@aws-sdk/client-codecommit");

// ES6+ example
import { CodeCommitClient, ListRepositoriesCommand } from "@aws-sdk/client-codecommit";

使用量

发出请求:

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

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

const params = { /** input parameters */ };
const command = new ListRepositoriesCommand(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"后缀.

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

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

import { CodeCommit } from "@aws-sdk/client-codecommit";

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

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

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

// callbacks (not recommended).
client.listRepositories(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-codecommit 软件包正在更新. 为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .

许可证

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

客户端命令( 操作列表)