@aws- sdk/ 客户控制目录

说明

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

欢迎使用控制目录 API 引用 。 本指南是为需要详细信息,说明如何在程序上识别和过滤亚马逊网络服务客户可用的共同控制和相关元数据而编写的。 这个API参考提供了Control Catalog支持的每个动作和数据类型的描述,语法和用法示例.

使用以下链接启动控制目录 API :

• 行动: 所有 Control Catalog API 操作的字母列表.

• 数据类型: 所有控制目录数据类型的字母列表.

• 共同参数:所有操作都可以使用的参数.

• 常见错误:所有操作都可以返回的客户端和服务器错误.

安装

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

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

开始

导入

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

// ES5 example
const { ControlCatalogClient, ListDomainsCommand } = require("@aws-sdk/client-controlcatalog");

// ES6+ example
import { ControlCatalogClient, ListDomainsCommand } from "@aws-sdk/client-controlcatalog";

使用量

发出请求:

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

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

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

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

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

import { ControlCatalog } from "@aws-sdk/client-controlcatalog";

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

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

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

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

许可证

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

客户端命令( 操作列表)