# @aws-sdk/client-synthetics 中文文档

规范地址：https://npmcn.com/package/%40aws-sdk/client-synthetics/

版本：3\.1164\.0
npm 元数据更新时间：2026-11-06T20:20:33.666Z
中文译文更新时间：2026-11-07T11:00:11.986Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aws-sdk/client-synthetics
原文对照：https://npmcn.com/package/%40aws-sdk/client-synthetics/?lang=original
项目主页：https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-synthetics
源码仓库：https://github.com/aws/aws-sdk-js-v3

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：541 kB，160 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：8 个
- 首次发布：2020-08-25T19:28:03.464Z
- 最新版本发布：2026-11-06T20:20:33.487Z
- 近 30 天下载量：202372（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：700（近 12 个月 220 个）

## 中文简介

JavaScript 合成客户端的 AWS SDK 用于 Node.js , 浏览器和 React Industrial

## 安装

```sh
npm install @aws-sdk/client-synthetics
```

也可以使用：`pnpm add @aws-sdk/client-synthetics`、`yarn add @aws-sdk/client-synthetics`、`bun add @aws-sdk/client-synthetics`

## README

# @aws-sdk/客户-合成

## 说明

JavaScript 合成客户端的 AWS SDK 为 Node.js , 浏览器和 React Introduct 的客户端.

亚马逊云表合成器

您可以使用 Amazon Cloud Watch 合成器来持续监控您的服务 。 你们可以 创建和管理 _金丝雀_,是模块化、轻量级脚本 用于监视您的端点和 API 从外出入. 你可以设置你的金丝雀跑 每天24小时,每分钟一次. 这些金丝雀可以帮你检查是否有时间和时间 通过调查负载时间数据来发现您的网络服务和故障排除异常, uI的截图,日志和度量衡. 金丝雀无缝地与"云表"融合 服务Lens 帮助您追踪您应用程序中受影响的节点的原因 。 为了更多 信息,见 [使用服务记录监视器 申请的健康状况](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ServiceLens.html) 输入 _亚马逊云表用户 指南_。 。 。 .

在创建和管理金丝雀之前,要注意安全考虑. 为了更多 信息,见 [警卫 合成金刚体的考虑](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html)。 。 。 .

## 安装

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

-   `npm install @aws-sdk/client-synthetics`
-   `yarn add @aws-sdk/client-synthetics`
-   `pnpm add @aws-sdk/client-synthetics`

## 开始

### 导入

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

```js
// ES5 example
const { SyntheticsClient, ListGroupsCommand } = require("@aws-sdk/client-synthetics");
```

```ts
// ES6+ example
import { SyntheticsClient, ListGroupsCommand } from "@aws-sdk/client-synthetics";
```

### 使用量

发出请求:

-   以配置(如证书,区域)为客户端提供证据.
    -   见 [文件/中心](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 SyntheticsClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListGroupsCommand(params);
```

#### 自动/等待

我们建议使用 [等待时](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"后缀.

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

如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(`SyntheticsClient`) (中文(简体) ). 更多详情见博客文章: [javaScript 的 AWS SDK 模块包](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)。 。 。 .

```ts
import { Synthetics } from "@aws-sdk/client-synthetics";

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

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

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

// callbacks (not recommended).
client.listGroups(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-synthetics` 软件包正在更新. 为了帮助客户,你可以检查我们 [生成客户端脚本](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/synthetics/command/AssociateResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/AssociateResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/AssociateResourceCommandOutput/)

创建动画

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/CreateCanaryCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/CreateCanaryCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/CreateCanaryCommandOutput/)

创建组

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/CreateGroupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/CreateGroupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/CreateGroupCommandOutput/)

删除动画

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/DeleteCanaryCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DeleteCanaryCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DeleteCanaryCommandOutput/)

删除组

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/DeleteGroupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DeleteGroupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DeleteGroupCommandOutput/)

描述

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/DescribeCanariesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DescribeCanariesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DescribeCanariesCommandOutput/)

描述动画 LastRun

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/DescribeCanariesLastRunCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DescribeCanariesLastRunCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DescribeCanariesLastRunCommandOutput/)

描述时间变化

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/DescribeRuntimeVersionsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DescribeRuntimeVersionsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DescribeRuntimeVersionsCommandOutput/)

断开关联资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/DisassociateResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DisassociateResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/DisassociateResourceCommandOutput/)

获取加那利

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/GetCanaryCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/GetCanaryCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/GetCanaryCommandOutput/)

获取卡纳里Runs

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/GetCanaryRunsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/GetCanaryRunsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/GetCanaryRunsCommandOutput/)

组

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/GetGroupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/GetGroupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/GetGroupCommandOutput/)

列表关联组

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/ListAssociatedGroupsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/ListAssociatedGroupsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/ListAssociatedGroupsCommandOutput/)

列表组资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/ListGroupResourcesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/ListGroupResourcesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/ListGroupResourcesCommandOutput/)

列表组

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/ListGroupsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/ListGroupsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/ListGroupsCommandOutput/)

列表标签格式资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/ListTagsForResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/ListTagsForResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/ListTagsForResourceCommandOutput/)

开始动画

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/StartCanaryCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/StartCanaryCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/StartCanaryCommandOutput/)

开始卡纳里干流

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/StartCanaryDryRunCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/StartCanaryDryRunCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/StartCanaryDryRunCommandOutput/)

停止动画

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/StopCanaryCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/StopCanaryCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/StopCanaryCommandOutput/)

标签资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/TagResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/TagResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/TagResourceCommandOutput/)

调和资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/UntagResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/UntagResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/UntagResourceCommandOutput/)

更新卡纳利语Name

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/synthetics/command/UpdateCanaryCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/UpdateCanaryCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-synthetics/Interface/UpdateCanaryCommandOutput/)

## 常见问题

### @aws-sdk/client-synthetics 是什么？

JavaScript 合成客户端的 AWS SDK 用于 Node\.js , 浏览器和 React Industrial

### 如何安装 @aws-sdk/client-synthetics？

在项目目录运行 npm install @aws-sdk/client-synthetics，或使用 pnpm add / yarn add / bun add。

### @aws-sdk/client-synthetics 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aws-sdk/client-synthetics 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @aws-sdk/client-synthetics 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @aws-sdk/client-synthetics 可以商用吗？

@aws-sdk/client-synthetics 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aws-sdk/client-synthetics 的下载量有多少？

根据 npm 官方下载统计，@aws-sdk/client-synthetics 在 2026/10/08 – 2026/11/06 这 30 天内被下载 202,372 次，日均约 6,746 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aws-sdk/client-synthetics 还在维护吗？

最新版本 3\.1164\.0 发布于 2026/11/07（1 天前）；至今共发布 700 个版本，其中过去 12 个月发布了 220 个；首次发布于 2020/08/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。