@aws-sdk/客户端-securityhub

说明

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

Security Hub CSPM 向您提供亚马逊网络服务安全状态的全景,并提供帮助 你根据安全行业标准和最佳做法评估你的亚马逊网络服务环境.

安全中心CSPM收集亚马逊网络服务账户、亚马逊网络服务服务的安全数据 支持第三方产品,帮助您分析安全趋势和确定最高优先安全 问题.

为了帮助您管理组织的安全状态,安全中心CSPM支持多种安全标准. 其中包括由亚马逊网络服务公司制定的亚马逊网络服务基础安全最佳做法标准, 和外部合规框架,如因特网安全中心(独联体)、支付卡行业数据 安全标准(PCI SDS)和国家标准和技术研究所(NIST). 每个标准包括: 几个安全管制,每个都代表安全最佳做法。 安保中心CSPM对 安全控制并生成控制结果,以帮助您对照安全最佳做法评估遵守规定的情况.

除了生成控制结果外,安全中心CSPM还接收其他亚马逊网络服务服务的结果, 亚马逊卫戍区和亚马逊督察区 支持第三方产品。 这给了你一个单一的玻璃板 进入各种与安全有关的问题。 你个 也可以将安全枢纽CSPM的发现发送给亚马逊其他网络服务,并支持第三方产品.

安全枢纽 CSPM 提供自动化功能,帮助您分解和补救安全问题. 譬如说, 您可以在安全检查失败时使用自动化规则自动更新关键结果。 您也可以与 Amazon Event Bridge)引发对具体发现的自动响应.

这个向导.. 安全中心 CSPM API 参考文献,提供 关于安全中心CSPM API的信息. 这包括支助资源、HTTP方法、参数、, 和计谋。 如果你是新到安全中心CSPM的 你可能会发现同样审查一下 安全中心 CSPM 用户指南 编辑 用户指南解释关键概念并提供程序 演示如何使用安全枢纽CSPM特性。 它还提供关于诸如下列专题的资料: 将安全枢纽CSPM与其他亚马逊网络服务服务整合.

除了通过给安全中心CSPM API打电话与安全中心CPSPM互动外,您还可以 使用当前版本的亚马逊网络服务命令行工具或SDK. 亚马逊网络服务提供工具 和SDK,由各种语言和平台的库和样本代码组成,如PowerShell, Java, Go, Python, C++, 和.NET. 这些工具和SDK提供了方便的、程序化的进入 安全中心CSPM和其他亚马逊网络服务服务 他们还处理签署请求等任务, 管理错误,并自动重试请求。 有关安装和使用亚马逊网络服务工具的信息 和SDKs,见 在亚马逊网络服务上构建的工具。 。 。 .

除与中央配置有关的操作外,安全枢纽CSPM API请求只在 正在运行的亚马逊网络服务区或您在请求中指定的亚马逊网络服务区。 任何配置或设置更改 行动的结果只适用于该地区。 做同样的改变 其它区域,请在您想要应用该修改的每个区域中调用相同的API操作。 当你使用中央配置时, 有关安全中心CSPM、标准和管制的API请求在家乡大区和所有相关大区执行。 名单 中央配置操作,参见 中央配置 术语和概念 页:1 安全中心 CSPM 用户指南。 。 。 .

以下节流限制适用于安全枢纽CSPM API操作.

• BatchEnableStandards - 说吧 RateLimit 每个请求1个 再来. BurstLimit 每秒1个请求.

• GetFindings - 说吧 RateLimit 每秒3个请求. BurstLimit 每秒6个请求.

• BatchImportFindings - 说吧 RateLimit 每秒10个请求. BurstLimit 每秒30个请求.

• BatchUpdateFindings - 说吧 RateLimit 每秒10个请求. BurstLimit 每秒30个请求.

• UpdateStandardsControl - 说吧 RateLimit 每个请求1个 再来. BurstLimit 每秒5个请求.

• 其他行动 RateLimit 每秒10个请求. BurstLimit 每秒30个请求.

安装

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

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

开始

导入

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

// ES5 example
const { SecurityHubClient, ListMembersCommand } = require("@aws-sdk/client-securityhub");

// ES6+ example
import { SecurityHubClient, ListMembersCommand } from "@aws-sdk/client-securityhub";

使用量

发出请求:

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

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

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

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

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

import { SecurityHub } from "@aws-sdk/client-securityhub";

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

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

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

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

许可证

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

客户端命令( 操作列表)