@aws-sdk/客户组织
说明
JavaScript Organizations的 AWS SDK 为Node.js 客户端,浏览器和React Industrial.
组织是一个网络服务, 使您能够整合您的多个 亚马逊Web 服务账户变为一个 组织 并集中管理您的 账户及其资源.
本指南介绍了各组织的API。 为了更多 关于使用此服务的信息,请参见 组织用户指南。 。 。 .
API 版本
这个版本的组织 API 参考文献 API 版本的组织 2016-11-28. (中文(简体) ).
作为直接使用API的替代品,你可以使用亚马逊网络服务SDKs之一, 由各种编程语言的图书馆和样本代码组成 平台(Java,Ruby,.NET,iOS,Android等). SDK提供方便 建立方案进入各组织的途径。 例如,SDK会照顾 加密签名请求、管理错误和重试请求 自动。 关于亚马逊网络服务SDK的更多信息,包括下载方式 并安装它们,你看 亚马逊网络工具 服务。 。 。 .
我们建议你们使用亚马逊网络服务 SDKs 向组织发出API的电话. 不过,您也可以使用组织查询API,直接拨打组织网络 服务。 欲了解更多关于组织查询的API,请参见: 通过制作 HTTP 查询调用 API 请求 输入 组织用户指南组织支持获取和 POST 请求所有动作 。 也就是说 API不要求你用一些 动作和他人的POST。 然而,GET请求受以下限制: a URL。 因此,对于需要更大尺寸的操作,使用POST请求.
签名请求
当您向 Amazon Web 服务发送 HTTP 请求时, 请签名, 以便 Amazon Web 服务能够识别 是谁派他们来的 您用您的 Amazon Web 服务访问密钥签名请求, 该密钥包含访问 密钥标识和密钥。 我们强烈建议你不要创造进入 键。 任何拥有您根账户访问密钥的人 请访问您的账户中的所有资源。 相反,创建访问密钥 对于拥有行政许可的IAM用户。 作为另一个选项, 使用 Amazon Web 服务 安全托肯服务(Amazon Web Service STS)生成临时安全证书,并使用 签署请求的全权证书.
为了签署请求,我们建议您使用 签字版本4。如果 拥有使用签名版本 2 的现有应用程序, 您无需更新它 以使用签名版本 4。 然而,一些操作现在需要签名版本4. 需要第4版操作的文件表明: 页:1.
当您使用命令行接口(CLI)或亚马逊网络服务 SDK 之一向 Amazon Web Services, 这些工具会用您访问的密钥自动为您签名 指定工具配置时间.
在此版中,每个组织只能有一个根.
对各组织的支助和反馈
我们欢迎你的反馈。 你可以把反馈和问题张贴在 组织支助 论坛。关于亚马逊网络服务支助论坛的更多信息,请参见: 论坛帮助。 。 。 .
要呼叫的终点 使用 CLI 或 Amazon 网络服务时 SDK 软件
对于目前发布的组织,请具体说明: us-east-1 区域
所有亚马逊网络服务 API和CLI的电话来自亚马逊商业网络服务区
中国. 如果来自中国亚马逊网络服务区之一,请具体说明
cn-northwest-1您可以使用这些参数在 CLI 中做到这一点
和命令 :
-
使用以下包含每个命令的参数来指定终点和 本区域:
--endpoint-url https://organizations.us-east-1.amazonaws.com(来自中国境外的亚马逊商业网络服务区)或者说
--endpoint-url https://organizations.cn-northwest-1.amazonaws.com.cn(来自中国亚马逊网络服务区) -
使用默认的终点, 但配置您的默认区域 命令 :
aws configure set default.region us-east-1(来自中国境外的亚马逊商业网络服务区)或者说
aws configure set default.region cn-northwest-1(来自中国亚马逊网络服务区) -
使用下列带有每个命令的参数来指定终点:
--region us-east-1(来自中国境外的亚马逊商业网络服务区)或者说
--region cn-northwest-1(来自中国亚马逊网络服务区)
如何介绍实例
组织事务处应你的要求退回的JSON 单长字符串,不中断行或格式化白空间。 这方面的实例 指南既包括换行符,也包括提高可读性的白空间。 当示例输入时 参数还会导致长字符串 将延伸到屏幕之外,我们 插入换行符以提高可读性。 总是以 JSON 文本提交输入 绳子.
记录 API 请求
组织支持 CloudTrail, 一个记录 Amazon Web Services API 调用您的服务 Amazon Web Services的账户,并将日志文件交付给一个Amazon S3桶. 通过使用收集的信息 cloudTrail),您可以确定收到哪些组织服务请求,由谁提供 请求和时间,等等。 更多关于组织及其对CloudTrail的支持,参见 日志 API用 CloudTrail 调用组织 输入 组织用户指南。学习更多关于 CloudTrail 的知识,包括如何改变它 打开并查找日志文件,参见 云轨用户指南。 。 。 .
安装
要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :
npm install @aws-sdk/client-organizationsyarn add @aws-sdk/client-organizationspnpm add @aws-sdk/client-organizations
开始
导入
AWS SDK由客户端和命令进行调制.
要发送请求,只需导入 OrganizationsClient 财务报告和审定财务报表
例如,您需要的命令 ListRootsCommand数字 :
// ES5 example
const { OrganizationsClient, ListRootsCommand } = require("@aws-sdk/client-organizations");
// ES6+ example
import { OrganizationsClient, ListRootsCommand } from "@aws-sdk/client-organizations";
使用量
发出请求:
- 以配置(如证书,区域)为客户端提供证据.
- 见 文件/中心 用于配置细节.
- 见 @aws- sdk/ 配置 附加选项.
- 以输入参数证明命令 .
- 打电话
send操作客户端,以输入方式提供命令对象.
const client = new OrganizationsClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new ListRootsCommand(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"后缀.
Organizations 扩展 OrganizationsClient 并额外支持所有操作,服务员, 和活人作为方法.
这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.
如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(OrganizationsClient) (中文(简体) ).
更多详情见博客文章:
javaScript 的 AWS SDK 模块包。 。 。 .
import { Organizations } from "@aws-sdk/client-organizations";
const client = new Organizations({ region: "REGION" });
// async/await.
try {
const data = await client.listRoots(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listRoots(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.listRoots(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-organizations 软件包正在更新.
为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .
许可证
此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.