@aws-sdk/客户健康
说明
JavaScript 健康客户端的 AWS SDK 为 Node.js, 浏览器和React Industrial.
卫生
卫生署提供获得卫生信息的机会,这些信息见于《公共卫生法》 卫生板。您可以使用 aPI 操作以获取可能影响您的 Amazon 网络服务服务和资源的事件信息 .
您必须拥有企业计划、企业计划或企业支持计划 亚马逊网络服务支助 使用健康API。 如果你给健康API打电话
Amazon Web Services 账户中没有企业、企业在线或企业支持计划,您将收到
SubscriptionRequiredException 错误.
对于API访问,您需要访问密钥ID和秘密访问密钥. 使用临时 可能时,证书而不是长期访问密钥。 临时全权证书包括: 一个访问密钥ID,一个秘密访问密钥,和一个显示何时 证书过期。 更多信息见 管理最佳做法 亚马逊网络服务访问密钥 输入 亚马逊网络服务总参考。 。 。 .
您可以使用健康端点健康.us-east-1.amazonaws.com (HTTPS)呼叫健康端点健康 健康API业务. 健康支持多区域应用架构 并具有两个区域终点的主动被动配置。 你可以使用高点 可用端点示例,以确定亚马逊网络服务区域是活动的,以便您能够 获取API的最新消息. 更多信息见 获得保健服务 API 密码 输入 健康用户指南。 。 。 .
为了认证请求,卫生署使用 签名版本4 签名 进程。 。 。 .
如果您的 Amazon 网络服务账户是组织的一部分, 您可以使用健康组织 视图特性。 这一特征集中了对各种卫生事件的看法 账户在您的组织。 您可实时汇总健康事件 识别您组织中受业务活动影响或获取的账户 * 通报安全弱点。 使用组织视图 API 操作启用 此特性和返回事件信息。 更多信息见 合计 卫生活动 输入 健康用户指南。 。 。 .
当您使用健康API操作返回健康事件时,请查看 建议如下:
-
使用 事件范围代码 指定是否返回的参数 公开或账户特定的事件.
-
使用 pagination 从响应查看所有事件 。 例如,如果你打电话 页:1
DescribeEventsForOrganization操作以获取您的全部事件 组织,您可能会收到多个页面结果。 指定nextToken在下一次请求中返回更多结果.
安装
要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :
npm install @aws-sdk/client-healthyarn add @aws-sdk/client-healthpnpm add @aws-sdk/client-health
开始
导入
AWS SDK由客户端和命令进行调制.
要发送请求,只需导入 HealthClient 财务报告和审定财务报表
例如,您需要的命令 DescribeEventsCommand数字 :
// ES5 example
const { HealthClient, DescribeEventsCommand } = require("@aws-sdk/client-health");
// ES6+ example
import { HealthClient, DescribeEventsCommand } from "@aws-sdk/client-health";
使用量
发出请求:
- 以配置(如证书,区域)为客户端提供证据.
- 见 文件/中心 用于配置细节.
- 见 @aws- sdk/ 配置 附加选项.
- 以输入参数证明命令 .
- 打电话
send操作客户端,以输入方式提供命令对象.
const client = new HealthClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new DescribeEventsCommand(params);
支持的信件协议
这个客户端支持多个协议.
此客户端的默认值是 AWS JSON (RPC) 1.1。 。 。 .
我们根据对 javaScript中此协议格式的性能特征. 你不需要改变它, 但您可以选择这样做,例如支持现有的整合或测试. 选择非默认协议更改格式 ,但不影响您如何与网络交互 使用 JavaScript 对象的客户端.
安装 @aws-sdk/config 软件包以访问其他协议.
见 AWS 议定书 更多信息.
AWS JSON (RPC) 1.1
本协议使用JSON有效载荷.
import { AwsJson1_1Protocol } from "@aws-sdk/config/protocol";
const client = new HealthClient({
protocol: AwsJson1_1Protocol
});
Smithy RPC v2 CBOR 游戏
本协议使用CBOR有效载荷.
import { AwsSmithyRpcV2CborProtocol } from "@aws-sdk/config/protocol";
const client = new HealthClient({
protocol: AwsSmithyRpcV2CborProtocol
});
自动/等待
我们建议使用 等待时 运算符等待通过发送操作返回的承诺如下:
// 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"后缀.
Health 扩展 HealthClient 并额外支持所有操作,服务员, 和活人作为方法.
这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.
如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(HealthClient) (中文(简体) ).
更多详情见博客文章:
javaScript 的 AWS SDK 模块包。 。 。 .
import { Health } from "@aws-sdk/client-health";
const client = new Health({ region: "REGION" });
// async/await.
try {
const data = await client.describeEvents(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.describeEvents(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.describeEvents(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-jsaWS 开发者博客. - 问个问题 叠叠流 并贴上标签
aws-sdk-js。 。 。 . - 加入 AWS JavaScript 社区 发光。 。 。 .
- 如果你发现你发现了一个虫子,请 打开一个问题。 。 。 .
为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .
捐款
此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-health 软件包正在更新.
为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .
许可证
此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.