@aws-sdk/ 客户端- 云层

说明

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

云轨

这是CloudTrail API参考。 它提供行动说明、数据 cloudTrail 的类型、通用参数和常见错误.

CloudTrail是一个记录 Amazon Web Services API 调用您的网络服务 Amazon Web Services的账户,并将日志文件交付给一个Amazon S3桶. 这个 所记录的信息包括用户身份,亚马逊网络服务API呼叫的起动时间,源IP地址,请求参数,以及响应 由服务返回元素.

作为API的替代品,您可以使用亚马逊网络服务SDK的其中一种 由各种编程语言和平台的图书馆和样本代码组成 (贾瓦,鲁比,.NET,iOS,Android等. SDK提供程序访问CloudTrail. 例如,SDKs处理加密签名请求, 管理错误,并自动重试请求。 欲了解更多信息 亚马逊网络服务SDK,包括如何下载和安装,见 在亚马逊网络服务上构建的工具。 。 。 .

见 云轨 用户指南 用于提供与日志文件中列出的每个亚马逊网络服务API呼叫相关的数据.

安装

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

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

开始

导入

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

// ES5 example
const { CloudTrailClient, ListImportsCommand } = require("@aws-sdk/client-cloudtrail");

// ES6+ example
import { CloudTrailClient, ListImportsCommand } from "@aws-sdk/client-cloudtrail";

使用量

发出请求:

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

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

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

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

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

import { CloudTrail } from "@aws-sdk/client-cloudtrail";

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

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

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

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

许可证

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

客户端命令( 操作列表)