@aws- sdk/ 客户端- 编码星连接

说明

JavaScript CodeStarConnections的 AWS SDK 为节点.js 客户端,浏览器和React Industrial.

AWS 代码星连接

这个 Amazon 网络服务代码Star 连接 API 参考文献提供描述和使用实例 amazon网络服务代码Star连接 API 的操作和数据类型。 你可以用这个 连接 API 与连接和安装工作.

连接 是连接亚马逊网络服务的配置 资源到外部代码寄存器。 每个连接都是可以给 连接到比特巴克特等第三方寄存器的 CodePipeline等服务. 对于 例如,您可以在 CodePipeline 中添加连接,以便在一个 代码更改为您的第三方代码存储器。 每个连接都命名为 与用于引用连接的独特 ARN 相关联.

当创建连接时,控制台启动第三方连接握手. 安装 是用来握手的应用程序。 对于 例如,Bitbucket供应商类型的安装是Bitbucket app. 当你 创建连接,您可以选择已有的安装或创建.

当您想要创建连接到 GitHub 等已安装的提供者类型时 企业服务器,您创建 东道主 为了你的连接.

您可以通过调用 :

• 创建连接,它创建了一个唯一命名的连接,可以是 由 CodePipeline 等服务引用.

• 删除连接,删除指定的连接.

• 获取连接,返回连接信息,包括 连接状态.

• 列表连接,其中列出与您 账户.

您可以与主机共事, 联系:

• 创建 Host,它创建了代表您供应商安装的基础设施的主机.

• 删除主机,删除指定的主机.

• 获取host,返回关于主机的信息,包括 设置状态.

• 列表主机,其中列出了与您相关的主机 账户.

您可以使用亚马逊网络服务代码Star Connections中的标签工作,使用以下方式:

• 列表标签格式资源,它获得关于 Amazon Web 服务标签的信息 指定 Amazon 资源名称(ARN) 在 Amazon Web 服务代码Star 连接.

• 标签资源,用于在 Amazon Web Services CodeStar 为资源添加或更新标签 连接.

• 调和资源,它将删除亚马逊网络服务代码Star中的资源标签 连接.

关于如何使用亚马逊网络服务代码Star连接的信息,参见 开发工具用户 指南。 。 。 .

安装

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

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

开始

导入

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

// ES5 example
const { CodeStarConnectionsClient, ListHostsCommand } = require("@aws-sdk/client-codestar-connections");

// ES6+ example
import { CodeStarConnectionsClient, ListHostsCommand } from "@aws-sdk/client-codestar-connections";

使用量

发出请求:

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

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

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

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

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

import { CodeStarConnections } from "@aws-sdk/client-codestar-connections";

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

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

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

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

许可证

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

客户端命令( 操作列表)