@aws- sdk/ 客户端支持
说明
JavaScript 支持 Node.js 客户端的 AWS SDK,浏览器和React Industrial 版本.
亚马逊网络服务支助
这个 亚马逊网络服务支持 API 参考 用于需要详细信息的程序员 有关亚马逊网络服务支持业务和数据类型的信息. 您可以使用 API 来管理 您的支援案例在程序上。 亚马逊网络服务支持 API 使用返回的 HTTP 方法 结果采用JSON格式.
-
您必须拥有亚马逊网络服务企业支持+,亚马逊网络服务企业支持,或者亚马逊网络服务统一运营计划使用亚马逊网络服务支持 API (英语). 如果你在亚马逊网络服务区不提供其中之一的亚马逊网络服务支持计划,或者如果你还没有向其中之一过渡,你可以使用亚马逊网络服务支持API,并配有企业,企业On-Ramp,或者企业支持计划.
-
如果您从没有账户的账户调用 Amazon Web 服务支持 API 亚马逊网络服务业务支持+,亚马逊网络服务企业支持,或亚马逊网络服务统一运营计划,the
SubscriptionRequiredException错误消息出现 。 对于 更改支持计划的信息,参见 亚马逊网络服务支助。 。 。 .
您也可以使用 Amazon Web 服务支持 API 访问功能 受托顾问您可以返回列表 检查及其说明, 得到检查结果, 指定检查以刷新 刷新检查状态 .
您可以使用以下的 Amazon Web 服务支持 API 操作管理您的支持案例 :
-
这个 创建案件, (中文(简体) ), 说明案例, (中文(简体) ), 说明,以及 解析程序 业务 创建 Amazon Web 服务支持案例,检索有关案例的信息,并解决案例.
-
这个 说明来文, (中文(简体) ), 添加通信目录,以及 添加选项 操作在 Amazon Web 服务支持中检索并添加通讯和附件 案例.
-
这个 描述服务 财务报告和审定财务报表 描述高度级别 操作返回 Amazon Web 服务名称、服务代码、服务类别和问题 严重程度。 您使用这些值来调用 创建案件 操作.
您也可以使用 Amazon 网络服务支持 API 调用 Trusted Advisor 操作 。 为了更多 信息,见 受托顾问 输入 亚马逊网络服务支持用户指南。 。 。 .
为了认证请求, 亚马逊网络服务支持用途 签名版本4 签名 进程。 。 。 .
关于此项服务及使用终点的更多信息,请参见 关于 亚马逊网络服务支持 API 输入 亚马逊网络服务支持用户指南。 。 。 .
安装
要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :
npm install @aws-sdk/client-supportyarn add @aws-sdk/client-supportpnpm add @aws-sdk/client-support
开始
导入
AWS SDK由客户端和命令进行调制.
要发送请求,只需导入 SupportClient 财务报告和审定财务报表
例如,您需要的命令 DescribeCasesCommand数字 :
// ES5 example
const { SupportClient, DescribeCasesCommand } = require("@aws-sdk/client-support");
// ES6+ example
import { SupportClient, DescribeCasesCommand } from "@aws-sdk/client-support";
使用量
发出请求:
- 以配置(如证书,区域)为客户端提供证据.
- 见 文件/中心 用于配置细节.
- 见 @aws- sdk/ 配置 附加选项.
- 以输入参数证明命令 .
- 打电话
send操作客户端,以输入方式提供命令对象.
const client = new SupportClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new DescribeCasesCommand(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"后缀.
Support 扩展 SupportClient 并额外支持所有操作,服务员, 和活人作为方法.
这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.
如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(SupportClient) (中文(简体) ).
更多详情见博客文章:
javaScript 的 AWS SDK 模块包。 。 。 .
import { Support } from "@aws-sdk/client-support";
const client = new Support({ region: "REGION" });
// async/await.
try {
const data = await client.describeCases(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.describeCases(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.describeCases(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-support 软件包正在更新.
为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .
许可证
此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.