@aws-sdk/客户 - iam

说明

JavaScript IAM 客户端的 AWS SDK 为Node.js, 浏览器和 React Industrial.

身份和访问管理

身份和访问管理(IAM)是一个网络服务,用于安全控制 获得亚马逊网络服务服务. 通过IAM,可以集中管理用户,安全证书 例如访问密钥,以及控制亚马逊Web Services资源用户和 应用程序可以访问。 关于IAM的更多信息,参见: 身份和出入管理 编辑 身份和访问管理用户指南。 。 。 .

IAM 程序访问

我们建议你们使用亚马逊网络服务 SDKs 向IAM发出API呼叫程序. 亚马逊网络服务 SDK由各种编程语言和平台的库和样本代码组成 (例如:Java,Ruby,.NET,iOS,和Android). SDK提供了一种方便的方式 创建IAM和亚马逊网络服务的程序访问。 例如,SDKs负责的任务有: 加密签名请求,管理错误,并自动重试请求. 更多信息见 利用工具 亚马逊网络服务。 。 。 .

或者,您也可以使用 IAM 查询 API 直接拨打 IAM 服务。 关于拨打IAM查询API的更多信息,请参见: 查询 请求 输入 身份和访问管理用户指南。IAM支持获取和 POST 请求所有动作 。 也就是说 API不要求您使用一些 动作和他人的POST。 但是,GET请求受以下限制: URL (中文(简体) ). 因此,对于需要更大尺寸的操作,使用POST请求.

签名请求

申请必须使用访问密钥ID和秘密访问密钥签名. 我们强烈地 建议您不要使用您的 Amazon Web 服务账户访问密钥 ID 和密钥访问 每天与IAM合作。 您可以使用访问密钥 ID 和密钥访问 IAM 用户或您可以使用安全托肯服务生成临时安全证书和使用 签署请求.

为了签署请求,我们建议您使用 签字版本4。如果您有 使用签名版本 2 的现有应用程序, 您无需更新即可使用 签名版 4. 然而,一些操作现在需要签名版 4. 这个 需要第4版操作的文档表明这一要求.

额外资源

• 亚马逊网络服务 安全证书2. 本专题提供一般资料,说明在哪些类别中 用于访问亚马逊网络服务的证书.

• 我最厉害 实践. 这一专题提出了使用IAM服务的建议清单 帮助保护您的 Amazon 网络服务资源.

• 签名 亚马逊网络服务 API 请求。这组主题将引导您通过签署 请求使用访问密钥 ID 和 秘密访问密钥.

安装

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

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

开始

导入

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

// ES5 example
const { IAMClient, ListGroupsCommand } = require("@aws-sdk/client-iam");

// ES6+ example
import { IAMClient, ListGroupsCommand } from "@aws-sdk/client-iam";

使用量

发出请求:

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

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

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

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

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

import { IAM } from "@aws-sdk/client-iam";

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

// async/await.
try {
  const data = await client.listGroups(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listGroups(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listGroups(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-iam 软件包正在更新. 为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .

许可证

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

客户端命令( 操作列表)