@aws-sdk/客户-wickr
说明
JavaScript Wickr 客户端的 AWS SDK 为 Node.js , 浏览器和 React Industrial 的 AWS SDK .
欢迎光临 亚马逊网络服务 Wickr API 参考。 。 。 .
亚马逊Web Services Wickr应用程序编程接口(API)是为管理员执行关键任务而设计的,例如创建和管理亚马逊Web Services Wickr,网络,用户,安全组,bots等. 本指南提供亚马逊网络服务Wickr API的详细信息,包括操作,类型,输入和输出,以及出错代码等. 您可以使用 Amazon Web Services SDK, Amazon Web Services Command Line 接口(Amazon Web Services CLI, 或 REST API) 来让 API 呼叫 Amazon Web Services Wickr.
使用 Amazon 网络服务 SDK
SDK客户端通过使用您提供的访问密钥认证您的请求 。 更多信息见 使用 Amazon 网络服务 SDK 和工具进行认证和访问 输入 亚马逊网络服务 SDKs和工具参考指南。 。 。 .
使用 Amazon 网络服务 CLI
使用与 Amazon Web 服务 CLI 的接入密钥进行 API 调用 。 关于建立亚马逊网络服务CLI的更多信息,请参见: 开始使用 Amazon 网络服务 CLI 输入 亚马逊网络服务命令行 第2版用户界面指南。 。 。 .
使用 REST APIs
如果您使用 REST 调用 API, 您必须通过提供签名来认证您的请求 。 Amazon Web Services Wickr支持签名版本 4. 更多信息,请参见 Amazon Web 服务签名版本 4 用于 API 请求 输入 亚马逊网络服务 身份和访问管理用户指南。 。 。 .
API的访问和权限可以由亚马逊网络服务身份和访问管理控制. 管理政策 亚马逊网络服务WickrFullAccess 给予亚马逊网络服务Wickr服务API全权行政许可. 关于限制进入具体业务的更多信息,见: 亚马逊网络服务Wickr的身份和访问管理 输入 亚马逊网络服务 Wickr 管理指南。 。 。 .
错误类型数字 :
亚马逊网络服务Wickr APIs提供HTTP接口. HTTP定义了不同类型错误响应的HTTP状态代码的范围.
-
客户端错误通过 HTTP 状态代码类 4xx 表示
-
HTTP 状态代码类别 5xx 表示服务错误
在本参考指南中,每个API的文档都有一个出错部分,其中包括对HTTP状态代码的简短讨论. 我们建议你发现错误时 将这里作为调查的一部分.
区域可用性
亚马逊网络服务Wickr API存在于多个亚马逊网络服务区,它为其中每一个区提供了一个终点. 关于所有各地区和终点的列表,请参见: 亚马逊网络服务 危险终点和配额 输入 亚马逊网络服务总参考指南。 。 。 .
Wickr API 端点是针对区域的,并包含格式中的区域代码: https://admin.wickr.[regioncode].amazonaws.com例如,美国东部(N.Virginia) us-east-1,API的终点是 https://admin.wickr.us-east-1.amazonaws.com。 。 。 .
安装
要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :
npm install @aws-sdk/client-wickryarn add @aws-sdk/client-wickrpnpm add @aws-sdk/client-wickr
开始
导入
AWS SDK由客户端和命令进行调制.
要发送请求,只需导入 WickrClient 财务报告和审定财务报表
例如,您需要的命令 ListBotsCommand数字 :
// ES5 example
const { WickrClient, ListBotsCommand } = require("@aws-sdk/client-wickr");
// ES6+ example
import { WickrClient, ListBotsCommand } from "@aws-sdk/client-wickr";
使用量
发出请求:
- 以配置(如证书,区域)为客户端提供证据.
- 见 文件/中心 用于配置细节.
- 见 @aws- sdk/ 配置 附加选项.
- 以输入参数证明命令 .
- 打电话
send操作客户端,以输入方式提供命令对象.
const client = new WickrClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new ListBotsCommand(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"后缀.
Wickr 扩展 WickrClient 并额外支持所有操作,服务员, 和活人作为方法.
这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.
如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(WickrClient) (中文(简体) ).
更多详情见博客文章:
javaScript 的 AWS SDK 模块包。 。 。 .
import { Wickr } from "@aws-sdk/client-wickr";
const client = new Wickr({ region: "REGION" });
// async/await.
try {
const data = await client.listBots(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listBots(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.listBots(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-wickr 软件包正在更新.
为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .
许可证
此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.