@aws-sdk/客户-ivschat

说明

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

导言

Amazon IVS 聊天控制平面 API 使您能够创建和管理 Amazon IVS 聊天 资源。 您还需要融入 亚马逊 IVS 聊天通讯 API 密码,使用户能够实时与聊天室互动.

API是一个AWS区域服务机构. 需要支持的区域列表和Amazon IVS Chat HTTPS 服务端点,请参见 Amazon IVS 聊天信息 亚马逊IVS页面 输入 AWS 一般参考。 。 。 .

本文描述了HTTP操作. 有一个单独的 邮件 API 密码 用于管理聊天资源;见 Amazon IVS 聊天通讯API 参考文献。 。 。 .

关于术语的说明:

• 您使用 Amazon IVS Chat API 创建服务应用程序 。 我们称之为 应用程序。 。 。 .

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

资源

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

• 日志配置 ——允许客户在聊天室存储并记录发送的信息的配置. 更多信息请参见日志配置端点 .

• 会议室 ——中央亚马逊IVS聊天资源通过 连接和交换聊天信息。 见房间的终点更多 资料.

缠绕

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

标记可以帮助您识别和组织您的 AWS 资源 。 例如,你可以使用 对不同的资源进行相同的标记,以表示它们具有关联性。 您也可以使用标记到 管理访问(参见 访问标记) (中文(简体) ).

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) 输入 亚马逊网络服务 一般参考。 。 。 .

• 管理亚马逊IVS权限——参见 身份和访问管理 打开 安全页 Amazon IVS 用户指南。 。 。 .

亚马逊资源名称( ARNs)

ARNs独有地识别AWS资源. 当需要指定时,需要使用 ARN 在所有AWS中,如IAM政策和API呼叫中,资源都毫不含糊. 为了更多 信息,见 亚马逊资源名称 输入 AWS 常规 参考文献。 。 。 .

安装

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

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

开始

导入

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

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

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

使用量

发出请求:

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

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

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

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

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

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.
});

解决问题

当服务返回例外时,错误将包括例外信息, 以及响应元数据(如请求编号).

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-ivschat 软件包正在更新. 为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .

许可证

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

客户端命令( 操作列表)