@aws-sdk/客户端-奇米
说明
JavaScript Chime 客户端的 AWS SDK 为 Node.js, 浏览器和React Industrial.
这些API大多不再被支持,也不会被更新. 我们建议使用最新版本 Amazon Chime SDK API 参考文献在亚马逊奇米SDK.
使用最新版本需要迁移到专用命名空间. 更多信息,参见 从亚马逊奇梅命名空间中移走 输入 亚马逊 Chime SDK 开发者指南。 。 。 .
Amazon Chime应用程序编程接口(API)的设计使管理员能够 执行关键任务,例如创建和管理Amazon Chime账户、用户和Voice 连接器。 本指南提供亚马逊Chime API的详细信息, 包括操作、类型、投入和产出以及出错代码.
您可以使用 AWS SDK, AWS 命令行接口(AWS CLI), 或者 REST API 来让 API 呼叫亚马逊 Chime. 我们建议使用 AWS SDK 或 AWS CLI (英语). 每个API动作的页面包含一个 另见 部分,包括使用特定语言的动作信息链接 AWS SDK 或 AWS CLI .
- 使用 AWS SDK 软件
-
您不需要写入代码来计算请求认证的签名 。 SDK客户端通过使用您提供的访问密钥认证您的请求 。 关于AWS SDKs的更多信息,请参见: AWS 开发者中心。 。 。 .
- 使用 AWS CLI
-
使用您的 AWS CLI 访问密钥进行 API 呼叫 。 关于建立AWS CLI的信息,参见: 安装 AWS 命令行接口 输入 AWS 命令行界面用户指南。关于可用的 Amazon Chime 命令列表,请参见 亚马逊 Chime 命令 输入 AWS CLI 命令参考。 。 。 .
- 使用 REST APIs
-
如果您使用 REST 调用 API, 您必须通过提供签名来认证您的请求 。 Amazon Chime支持签名版本 4. 更多信息,请参见 签名版本4 签名进程 输入 亚马逊网络服务总参考。 。 。 .
制作 REST API 呼叫时,请使用服务名
chime和 REST 端点https://service.chime.aws.amazon.com。 。 。 .
行政许可使用AWS身份和访问管理(IAM)进行控制. 更多信息见 Amazon Chime 的身份和访问管理 输入 Amazon Chime 管理指南。 。 。 .
安装
要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :
npm install @aws-sdk/client-chimeyarn add @aws-sdk/client-chimepnpm add @aws-sdk/client-chime
开始
导入
AWS SDK由客户端和命令进行调制.
要发送请求,只需导入 ChimeClient 财务报告和审定财务报表
例如,您需要的命令 ListAccountsCommand数字 :
// ES5 example
const { ChimeClient, ListAccountsCommand } = require("@aws-sdk/client-chime");
// ES6+ example
import { ChimeClient, ListAccountsCommand } from "@aws-sdk/client-chime";
使用量
发出请求:
- 以配置(如证书,区域)为客户端提供证据.
- 见 文件/中心 用于配置细节.
- 见 @aws- sdk/ 配置 附加选项.
- 以输入参数证明命令 .
- 打电话
send操作客户端,以输入方式提供命令对象.
const client = new ChimeClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new ListAccountsCommand(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"后缀.
Chime 扩展 ChimeClient 并额外支持所有操作,服务员, 和活人作为方法.
这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.
如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(ChimeClient) (中文(简体) ).
更多详情见博客文章:
javaScript 的 AWS SDK 模块包。 。 。 .
import { Chime } from "@aws-sdk/client-chime";
const client = new Chime({ region: "REGION" });
// async/await.
try {
const data = await client.listAccounts(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listAccounts(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.listAccounts(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-chime 软件包正在更新.
为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .
许可证
此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.