@aws- sdk/ 客户端- appconfigdata

说明

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

AppConfig 数据提供您用于检索的应用程序的数据平面 API 配置数据。 是这样的:

您的应用程序通过首先建立配置来获取配置数据 使用 AppConfig 数据的会话 开始配置会话 API动作. 您的会话客户端会定期打给 获取 Latest 配置 以检查和检索现有最新数据.

打电话时 StartConfigurationSession,您的代码发送如下 资料:

• AppConfig 应用程序的标识符(ID或名称),环境,以及 会话所跟踪的配置配置 .

• (备选) 会话客户端在通话之间必须等待的最低时间 改为 GetLatestConfiguration。 。 。 .

作为回应,AppConfig提供 InitialConfigurationToken 将交给 该会话的客户端并使用它第一次调用 GetLatestConfiguration 参加那届会议.

在你第一次打给 GetLatestConfiguration。 。 必须 使用新符号 输入 GetLatestConfiguration 回应 (单位:千美元)NextPollConfigurationToken在以后的每次呼吁中 GetLatestConfiguration。 。 。 .

打电话时 GetLatestConfiguration,您的客户端代码发送最新 ConfigurationToken 其价值为:

• NextPollConfigurationToken页:1 ConfigurationToken 价值 下次呼叫时使用 GetLatestConfiguration。 。 。 .

• NextPollIntervalInSeconds: 客户端应当等待的时间 下一个呼叫 GetLatestConfiguration。这一期限可能不同 在会议期间,应使用该数值,而不是发送在 StartConfigurationSession 电话.

• 配置:用于会话的最新数据. 如果 客户端已经拥有最新版本的配置.

这个 InitialConfigurationToken 财务报告和审定财务报表 NextPollConfigurationToken 应只使用一次。 支持长期投票 使用大小写,符号有效期最长为24小时。 如果有的话 GetLatestConfiguration 调用过期的符号,系统返回 BadRequestException。 。 。 .

欲了解更多信息并查看显示如何取回一个 使用 AppConfig 数据配置 StartConfigurationSession 财务报告和审定财务报表 GetLatestConfiguration API 动作,参见 获取 配置 输入 AppConfig 用户指南。 。 。 .

安装

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

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

开始

导入

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

// ES5 example
const { AppConfigDataClient, GetLatestConfigurationCommand } = require("@aws-sdk/client-appconfigdata");

// ES6+ example
import { AppConfigDataClient, GetLatestConfigurationCommand } from "@aws-sdk/client-appconfigdata";

使用量

发出请求:

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

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

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

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

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

import { AppConfigData } from "@aws-sdk/client-appconfigdata";

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

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

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

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

许可证

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

客户端命令( 操作列表)