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

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

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

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

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

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

- 包体积（解压后）：380 kB，130 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：8 个
- 首次发布：2022-04-26T19:13:47.939Z
- 最新版本发布：2026-11-06T20:17:35.030Z
- 近 30 天下载量：135277（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：612（近 12 个月 220 个）

## 中文简介

JavaScript Ivschat 节点客户端的 AWS SDK, 浏览器和回放本地

## 安装

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

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

## README

# @aws-sdk/客户-ivschat

## 说明

JavaScript Ivschat 客户端的 AWS SDK 为节点.js, 浏览器和React Industrial.

**导言**

Amazon IVS 聊天控制平面 API 使您能够创建和管理 Amazon IVS 聊天 资源。 您还需要融入 [亚马逊 IVS 聊天通讯 API 密码](https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html),使用户能够实时与聊天室互动.

API是一个AWS区域服务机构. 需要支持的区域列表和Amazon IVS Chat HTTPS 服务端点,请参见 Amazon IVS 聊天信息 [亚马逊IVS页面](https://docs.aws.amazon.com/general/latest/gr/ivs.html) 输入 _AWS 一般参考_。 。 。 .

本文描述了HTTP操作. 有一个单独的 _邮件_ API 密码 用于管理聊天资源;见 [Amazon IVS 聊天通讯API 参考文献](https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html)。 。 。 .

**关于术语的说明:**

-   您使用 Amazon IVS Chat API 创建服务应用程序 。 我们称之为 _应用程序_。 。 。 .
    
-   您创建前端客户端应用程序( 浏览器和Android/ iOS apps) 亚马逊IVS聊天通讯API. 我们称之为 _客户_。 。 。 .
    

**资源**

以下资源属于亚马逊IVS Chat(英语:Amazon IVS Chat)

-   **日志配置** ——允许客户在聊天室存储并记录发送的信息的配置. 更多信息请参见日志配置端点 .
    
-   **会议室** ——中央亚马逊IVS聊天资源通过 连接和交换聊天信息。 见房间的终点更多 资料.
    

**缠绕**

A 类 _标签_ 是您为 AWS 资源指定的元数据标签。 标签 由下列员额组成: _键_ (单位:千美元) _价值_你们俩都安排好了 对于 标记为 `topic:nature` 标记特定视频 类别。 见 [最佳做法和战略](https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html) 内 _Taging Amazon 网络服务资源和标签编辑器_ 详细内容,包括适用于标签和"标签命名限制和要求"的限制; Amazon IVS Chat没有服务特定性 受到的限制超出了文件所列的范围.

标记可以帮助您识别和组织您的 AWS 资源 。 例如,你可以使用 对不同的资源进行相同的标记,以表示它们具有关联性。 您也可以使用标记到 管理访问(参见 [访问标记](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)) (中文(简体) ).

Amazon IVS Chat API有这些与标记相关的操作: 标签资源, (中文(简体) ), 调和资源,以及 列表标签格式资源。下列资源支持标记:.

最多50个标记可以应用到一个资源上.

**API 访问安全**

您的 Amazon IVS 聊天应用程序( 服务应用程序和客户端) 必须认证 并被授权访问亚马逊IVS聊天资源. 注意这些差异: 概念:

-   _认证_ 是为了验证身份 请求 亚马逊IVS Chat API 必须签名来验证您的身份 .
    
-   _授权_ 这是关于批准。 您的IAM角色需要 对 Amazon IVS Chat API 请求有权限.
    

用户(查看器)使用您使用此功能创建的安全访问符连接到一个房间 创建 ChatToken 通过AWS SDK操作. 您调用 CreateChatToken 为 每个用户的聊天会话、传递身份和授权信息 用户.

**签名 API 请求**

HTTP API 请求必须使用 AWS SigV4 安全签名 证书。 AWS命令行接口(CLI)和AWS SDK负责签名 地下API呼叫你。 但是, 如果您的应用程序名为 Amazon IVS Chat HTTP API 签署申请是您的责任.

您使用有效的 AWS 证书来生成一个有权限的 IAM 角色的签名 执行请求的行动。 例如,必须使用 IAM 请求删除邮件 的作用 `ivschat:DeleteMessage` 允许.

更多信息:

-   认证和生成签名——见 [正在验证请求 (Amazon网络服务签名版本4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) 输入 _亚马逊网络服务 一般参考_。 。 。 .
    
-   管理亚马逊IVS权限——参见 [身份和访问管理](https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html) 打开 安全页 _Amazon IVS 用户指南_。 。 。 .
    

**亚马逊资源名称( ARNs)**

ARNs独有地识别AWS资源. 当需要指定时,需要使用 ARN 在所有AWS中,如IAM政策和API呼叫中,资源都毫不含糊. 为了更多 信息,见 [亚马逊资源名称](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) 输入 _AWS 常规 参考文献_。 。 。 .

## 安装

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

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

## 开始

### 导入

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

```js
// ES5 example
const { IvschatClient, ListRoomsCommand } = require("@aws-sdk/client-ivschat");
```

```ts
// ES6+ example
import { IvschatClient, ListRoomsCommand } from "@aws-sdk/client-ivschat";
```

### 使用量

发出请求:

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

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

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

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

```ts
import { Ivschat } from "@aws-sdk/client-ivschat";

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

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

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

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

## 客户端命令( 操作列表)

创建 ChatToken

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

创建日志配置

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

创建房间

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

删除日志配置

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

删除信件

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

删除房间

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

断开用户

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

获取日志配置

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

获取房间

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

列表日志配置

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

列表房间

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

列表标签格式资源

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

发送事件

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

标签资源

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

调和资源

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

更新日志配置

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

更新房间

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

## 常见问题

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

JavaScript Ivschat 节点客户端的 AWS SDK, 浏览器和回放本地

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

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

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

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

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

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

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

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

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

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

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

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

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

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