# @aws-sdk/client-health 中文文档 规范地址：https://npmcn.com/package/%40aws-sdk/client-health/ 版本：3\.1164\.0 npm 元数据更新时间：2026-11-06T20:17:34.020Z 中文译文更新时间：2026-11-07T10:55:10.875Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40aws-sdk/client-health 原文对照：https://npmcn.com/package/%40aws-sdk/client-health/?lang=original 项目主页：https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-health 源码仓库：https://github.com/aws/aws-sdk-js-v3 ## 关键信息（来自 npm 元数据） - 包体积（解压后）：455 kB，142 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - Node.js 要求：\>=20\.0\.0 - 运行依赖：8 个 - 首次发布：2020-01-08T03:11:17.882Z - 最新版本发布：2026-11-06T20:17:33.811Z - 近 30 天下载量：230185（2026-10-08 至 2026-11-06，npm 官方下载统计） - 已发布版本数：733（近 12 个月 220 个） ## 中文简介 JavaScript 健康客户端的 AWS SDK 为 Node.js, 浏览器和 React Industrial ## 安装 ```sh npm install @aws-sdk/client-health ``` 也可以使用：`pnpm add @aws-sdk/client-health`、`yarn add @aws-sdk/client-health`、`bun add @aws-sdk/client-health` ## README # @aws-sdk/客户健康 ## 说明 JavaScript 健康客户端的 AWS SDK 为 Node.js, 浏览器和React Industrial. 卫生 卫生署提供获得卫生信息的机会,这些信息见于《公共卫生法》 [卫生板](https://health.aws.amazon.com/health/home)。您可以使用 aPI 操作以获取可能影响您的 Amazon 网络服务服务和资源的事件信息 . 您必须拥有企业计划、企业计划或企业支持计划 [亚马逊网络服务支助](http://aws.amazon.com/premiumsupport/) 使用健康API。 如果你给健康API打电话 Amazon Web Services 账户中没有企业、企业在线或企业支持计划,您将收到 `SubscriptionRequiredException` 错误. 对于API访问,您需要访问密钥ID和秘密访问密钥. 使用临时 可能时,证书而不是长期访问密钥。 临时全权证书包括: 一个访问密钥ID,一个秘密访问密钥,和一个显示何时 证书过期。 更多信息见 [管理最佳做法 亚马逊网络服务访问密钥](https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html) 输入 _亚马逊网络服务总参考_。 。 。 . 您可以使用健康端点健康.us-east-1.amazonaws.com (HTTPS)呼叫健康端点健康 健康API业务. 健康支持多区域应用架构 并具有两个区域终点的主动被动配置。 你可以使用高点 可用端点示例,以确定亚马逊网络服务区域是活动的,以便您能够 获取API的最新消息. 更多信息见 [获得保健服务 API 密码](https://docs.aws.amazon.com/health/latest/ug/health-api.html) 输入 _健康用户指南_。 。 。 . 为了认证请求,卫生署使用 [签名版本4 签名 进程](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)。 。 。 . 如果您的 Amazon 网络服务账户是组织的一部分, 您可以使用健康组织 视图特性。 这一特征集中了对各种卫生事件的看法 账户在您的组织。 您可实时汇总健康事件 识别您组织中受业务活动影响或获取的账户 \* 通报安全弱点。 使用组织视图 API 操作启用 此特性和返回事件信息。 更多信息见 [合计 卫生活动](https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) 输入 _健康用户指南_。 。 。 . 当您使用健康API操作返回健康事件时,请查看 建议如下: - 使用 [事件范围代码](https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode) 指定是否返回的参数 公开或账户特定的事件. - 使用 pagination 从响应查看所有事件 。 例如,如果你打电话 页:1 `DescribeEventsForOrganization` 操作以获取您的全部事件 组织,您可能会收到多个页面结果。 指定 `nextToken` 在下一次请求中返回更多结果. ## 安装 要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI : - `npm install @aws-sdk/client-health` - `yarn add @aws-sdk/client-health` - `pnpm add @aws-sdk/client-health` ## 开始 ### 导入 AWS SDK由客户端和命令进行调制. 要发送请求,只需导入 `HealthClient` 财务报告和审定财务报表 例如,您需要的命令 `DescribeEventsCommand`数字 : ```js // ES5 example const { HealthClient, DescribeEventsCommand } = require("@aws-sdk/client-health"); ``` ```ts // ES6+ example import { HealthClient, DescribeEventsCommand } from "@aws-sdk/client-health"; ``` ### 使用量 发出请求: - 以配置(如证书,区域)为客户端提供证据. - 见 [文件/中心](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) 用于配置细节. - 见 [@aws- sdk/ 配置](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) 附加选项. - 以输入参数证明命令 . - 打电话 `send` 操作客户端,以输入方式提供命令对象. ```js 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 议定书](https://smithy.io/2.0/aws/protocols/index.html) 更多信息. ##### AWS JSON (RPC) 1.1 本协议使用JSON有效载荷. ```js import { AwsJson1_1Protocol } from "@aws-sdk/config/protocol"; const client = new HealthClient({ protocol: AwsJson1_1Protocol }); ``` ##### Smithy RPC v2 CBOR 游戏 本协议使用CBOR有效载荷. ```js import { AwsSmithyRpcV2CborProtocol } from "@aws-sdk/config/protocol"; const client = new HealthClient({ protocol: AwsSmithyRpcV2CborProtocol }); ``` #### 自动/等待 我们建议使用 [等待时](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) 运算符等待通过发送操作返回的承诺如下: ```js // async/await. try { const data = await client.send(command); // process data. } catch (error) { // error handling. } finally { // finally. } ``` #### 承诺 您还可以使用 [承诺连锁](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)。 。 。 . ```js 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 模块包](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)。 。 。 . ```ts 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. }); ``` ### 解决问题 当服务返回例外时,错误将包括例外信息, 以及响应元数据(如请求编号). ```js 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; * } */ } ``` 另见 [文档/错误](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md)。 。 。 . ## 获取帮助 请利用这些社区资源获得帮助. 我们使用 GitHub 问题来跟踪错误和特性请求,但处理它们的带宽有限. - 访问 [开发者指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) 或者说 [API 参考](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html)。 。 。 . - 看看贴有标签的博客文章 [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) aWS 开发者博客. - 问个问题 [叠叠流](https://stackoverflow.com/questions/tagged/aws-sdk-js) 并贴上标签 `aws-sdk-js`。 。 。 . - 加入 AWS JavaScript 社区 [发光](https://gitter.im/aws/aws-sdk-js-v3)。 。 。 . - 如果你发现你发现了一个虫子,请 [打开一个问题](https://github.com/aws/aws-sdk-js-v3/issues/new/choose)。 。 。 . 为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 [代码样本 repo](https://github.com/aws-samples/aws-sdk-js-tests)。 。 。 . ## 捐款 此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 `@aws-sdk/client-health` 软件包正在更新. 为了帮助客户,你可以检查我们 [生成客户端脚本](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients)。 。 。 . ## 许可证 此 SDK 分布于 [Apache 许可证,2.0版本](http://www.apache.org/licenses/LICENSE-2.0), (中文(简体) ), 更多信息见LICENSE. ## 客户端命令( 操作列表) 说明组织受影响的账户 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeAffectedAccountsForOrganizationCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeAffectedAccountsForOrganizationCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeAffectedAccountsForOrganizationCommandOutput/) 描述受影响的实体 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeAffectedEntitiesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeAffectedEntitiesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeAffectedEntitiesCommandOutput/) 为组织描述受影响的实体 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeAffectedEntitiesForOrganizationCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeAffectedEntitiesForOrganizationCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeAffectedEntitiesForOrganizationCommandOutput/) 描述实体 合计数 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeEntityAggregatesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEntityAggregatesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEntityAggregatesCommandOutput/) 组织实体 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeEntityAggregatesForOrganizationCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEntityAggregatesForOrganizationCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEntityAggregatesForOrganizationCommandOutput/) 描述事件 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeEventAggregatesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventAggregatesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventAggregatesCommandOutput/) 描述活动细节 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeEventDetailsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventDetailsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventDetailsCommandOutput/) 描述组织活动的详情 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeEventDetailsForOrganizationCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventDetailsForOrganizationCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventDetailsForOrganizationCommandOutput/) 描述事件 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeEventsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventsCommandOutput/) 描述组织活动 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeEventsForOrganizationCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventsForOrganizationCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventsForOrganizationCommandOutput/) 描述事件类型 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeEventTypesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventTypesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeEventTypesCommandOutput/) 描述组织的保健服务状况 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeHealthServiceStatusForOrganizationCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeHealthServiceStatusForOrganizationCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeHealthServiceStatusForOrganizationCommandOutput/) 描述服务周期 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DescribeServiceLifecycleCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeServiceLifecycleCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DescribeServiceLifecycleCommandOutput/) 禁用为组织提供的保健服务 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/DisableHealthServiceAccessForOrganizationCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DisableHealthServiceAccessForOrganizationCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/DisableHealthServiceAccessForOrganizationCommandOutput/) 启用组织的保健服务访问 [命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/health/command/EnableHealthServiceAccessForOrganizationCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/EnableHealthServiceAccessForOrganizationCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-health/Interface/EnableHealthServiceAccessForOrganizationCommandOutput/) ## 常见问题 ### @aws-sdk/client-health 是什么？ JavaScript 健康客户端的 AWS SDK 为 Node\.js, 浏览器和 React Industrial ### 如何安装 @aws-sdk/client-health？ 在项目目录运行 npm install @aws-sdk/client-health，或使用 pnpm add / yarn add / bun add。 ### @aws-sdk/client-health 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @aws-sdk/client-health 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @aws-sdk/client-health 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @aws-sdk/client-health 可以商用吗？ @aws-sdk/client-health 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @aws-sdk/client-health 的下载量有多少？ 根据 npm 官方下载统计，@aws-sdk/client-health 在 2026/10/08 – 2026/11/06 这 30 天内被下载 230,185 次，日均约 7,673 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @aws-sdk/client-health 还在维护吗？ 最新版本 3\.1164\.0 发布于 2026/11/07（1 天前）；至今共发布 733 个版本，其中过去 12 个月发布了 220 个；首次发布于 2020/01/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。