@aws-sdk/ 客户端- 机密管理器

说明

JavaScript SecretsManager Client for Node.js的AWS SDK,浏览器和React Introduct的客户端.

亚马逊网络服务保密管理器

Amazon Web Services Secretments Management提供一种服务,使您能够存储,管理和检索机密.

本指南提供"秘密管理者API"的描述. 关于使用此工具的更多信息 服务,见 亚马逊网络服务保密管理器用户指南。 。 。 .

API 版本

这个版本的秘密管理者API参考文件记载了秘密管理者API2017-10-17版本.

关于终点列表,见 亚马逊网络服务保密管理器 结束点。 。 。 .

对亚马逊网络服务保密管理器的支持和反馈

我们欢迎你的反馈。 将您的评论发送到 [email protected] (英语),或将反馈和问题张贴到 亚马逊网络服务秘密管理者讨论论坛为更多 关于亚马逊网络服务讨论论坛的信息,见 论坛 帮助。 。 。 .

登录 API 请求

Amazon Web Services Secretments Management支持 Amazon Web Services CloudTrail,一个记录 Amazon Web Services API 呼唤您的 Amazon Web Services的服务的服务 账户,并将日志文件传送给亚马逊 S3 桶。 通过使用收集的信息 通过Amazon Web Services CloudTrail,您可以确定成功向秘密管理者提出的请求,后者做了 请求,何时提出,等等。 更多关于亚马逊网络服务保密管理器及对亚马逊网络服务的支持 云轨,看 日志 与 Amazon Web 服务 CloudTrail 一起的 Amazon Web 服务秘密管理器事件 输入 亚马逊网络服务保密管理器用户指南。 。 。 . 要了解更多关于 CloudTrail 的信息,包括启用它并找到您的日志文件,请查看 亚马逊网络服务 CloudTrail 用户指南。 。 。 .

安装

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

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

开始

导入

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

// ES5 example
const { SecretsManagerClient, ListSecretsCommand } = require("@aws-sdk/client-secrets-manager");

// ES6+ example
import { SecretsManagerClient, ListSecretsCommand } from "@aws-sdk/client-secrets-manager";

使用量

发出请求:

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

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

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

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

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

import { SecretsManager } from "@aws-sdk/client-secrets-manager";

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

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

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

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

许可证

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

客户端命令( 操作列表)