@aws- sdk/ 客户端编码目录

说明

JavaScript CodeCatalyst Client for Node.js的AWS SDK,浏览器和React Independent的客户端.

欢迎来到亚马逊代码Catalyst API参考. 本参考文献提供亚马逊CodeCatalyst的操作和数据类型描述. 您可以使用 Amazon 代码Catalyst API 用于处理以下对象 .

空间,通过调用如下:

• 删除空格,删除空格.

• 获取空间,返回关于空间的信息.

• 获取订阅,它返回用于计费目的关于亚马逊网络服务账户的信息 和空间计费计划.

• 列表空间,可以获取一个空格列表.

• 更新空间,用于修改一个空格的一个或多个值.

项目,称为:

• 创建工程 在指定空间创建工程.

• 获取项目,它返回一个工程的信息.

• 列表项目,可以获取空间中的项目列表.

用户,通过调用如下:

• 获取用户详情,它返回关于Amazon CodeCatalyst中一个用户的信息.

源寄存器,称为:

• 创建来源仓库,在指定的工程中创建一个空的基于 Git 的源寄存器.

• 创建来源存储器,在指定的寄存器中创建分支,您可以在其中工作代码.

• 删除来源仓库,删除源寄存器.

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

• 获取来源存储器,它返回可以使用 Git 客户端复制源的 URL 信息 仓库.

• 列表来源仓库,它检索项目中的源寄存器列表.

• 列表 源目录,它检索源寄存器中的分支列表.

Dev Environments 和亚马逊网络服务工具包,称:

• 创建环境它创造了一个Dev环境, 您可以在您的工程的源寄存器中快速处理存储的代码.

• 删除环境,删除 Dev 环境.

• 获取环境,返回关于 Dev 环境的信息.

• ListDev 环境,它检索项目中的 Dev Environments 列表.

• 列表环境会议,它检索项目中活动 Dev 环境会话的列表.

• 启动环境,它开始一个指定的 Dev 环境,并将其置于活动状态.

• 开始环境会议,它从指定的 Dev 环境开始会话.

• 停止环境,它会停止指定的 Dev 环境,并将它变成停止状态.

• 停止环境会议,用于指定 Dev Environment 的会话.

• 更新环境,用于修改一个 Dev 环境的一个或多个值.

工作流程,具体如下:

• 获取工作流程,它返回关于工作流程的信息.

• 获取工作流程运行,它返回关于指定工作流程运行的信息.

• 列表工作流程运行,可以获取指定工作流程运行列表.

• 工作流程列表,它检索指定项目中的工作流程列表.

• 开始工作流程运行,开始运行指定的工作流程.

Amazon CodeCatalyst的安保、活动和资源管理,具体如下:

• 创建访问文件夹,它为当前用户创建个人访问符 (PAT) .

• 删除访问文件夹,删除指定的个人访问符 (PAT).

• 列表访问文件夹,它列出了所有与用户相关的个人访问符 (PAT) .

• 列表事件日志,它检索一个空间中特定时间段内发生的事件列表.

• 校验会话,用于验证调用用户是否有有效的 Amazon CodeCatalyst 登录和会话.

如果您使用带有 SDK 或 CLI 的 Amazon CodeCatalyst API, 您必须配置您的计算机, 以便与 Amazon CodeCatalyst 和 单一签名( SSO) 合作 . 更多信息见 设置使用 Amazon CodeCatalyst 的 CLI 和你的SDK的SSO文档.

安装

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

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

开始

导入

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

// ES5 example
const { CodeCatalystClient, ListSpacesCommand } = require("@aws-sdk/client-codecatalyst");

// ES6+ example
import { CodeCatalystClient, ListSpacesCommand } from "@aws-sdk/client-codecatalyst";

使用量

发出请求:

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

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

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

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

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

import { CodeCatalyst } from "@aws-sdk/client-codecatalyst";

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

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

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

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

许可证

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

客户端命令( 操作列表)