@aws-sdk/客户资源探索者-2

说明

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

亚马逊网络服务资源探索(Amazon Web Services Resource Explorer)是一种资源搜索和发现服务. 通过使用资源探索器,您可以使用类似互联网搜索引擎的经验来探索您的资源. 资源的例子包括亚马逊关系数据库服务(Amazon RDS)实例,亚马逊简易存储服务(Amazon S3)桶,或亚马逊DynamoDB表格. 您可以使用名称、标签和ID等资源元数据搜索您的资源。 资源探索器可以搜索您打开该服务的账户中所有亚马逊网络服务区域,以简化您跨区域的工作量.

资源探索者扫描了您亚马逊网络服务账户中每个亚马逊网络服务区域的资源,您打开资源探索者。 资源探索器 创建和维护索引 详细介绍各地区的资源.

你们可以 搜索您账户中的所有索引区域 指定您的 Amazon 网络服务区域 包含账户的汇总索引 。 当你 促进一个地区的本地指数成为账户的汇总指数,资源探索器会自动将索引信息从其他地区所有本地索引复制到聚合索引. 因此,拥有汇总索引的区域在您打开资源探索器的账户中有一个所有区域所有资源信息的副本。 因此,汇总指数区域中的视图包含您账户中所有索引区域的资源.

关于亚马逊网络服务资源探索器的更多信息,包括如何启用和配置服务,请参见 亚马逊网络服务资源浏览器用户指南。 。 。 .

安装

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

• npm install @aws-sdk/client-resource-explorer-2
• yarn add @aws-sdk/client-resource-explorer-2
• pnpm add @aws-sdk/client-resource-explorer-2

开始

导入

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

// ES5 example
const { ResourceExplorer2Client, ListIndexesCommand } = require("@aws-sdk/client-resource-explorer-2");

// ES6+ example
import { ResourceExplorer2Client, ListIndexesCommand } from "@aws-sdk/client-resource-explorer-2";

使用量

发出请求:

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

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

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

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

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

import { ResourceExplorer2 } from "@aws-sdk/client-resource-explorer-2";

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

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

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

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

许可证

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

客户端命令( 操作列表)