@aws- sdk/ 客户端- 质子

说明

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

这是质子服务 API 参考。 它为每个用户提供描述、语法和使用实例 动作 财务报告和审定财务报表 数据类型 为质子 服务.

每个动作的文档显示查询API请求参数和XML响应.

或者,您可以使用 Amazon 网络服务 CLI 访问 API 。 更多信息,请参见 亚马逊网络服务命令行用户 指南。 。 。 .

质子服务是一个双向自动化框架. 管理员创建服务模板以提供 标准化基础设施和部署工具,用于无服务器和以集装箱为基础的应用。 开发者, 在 回合,从现有的服务模板中选择,使其应用程序或服务部署自动化.

由于管理员定义质子部署和管理的基础设施和工具,他们需要 允许使用所有列出的 API 操作.

当开发者选择一个特定的基础设施和工具集时,质子会部署他们的应用程序. 改为: 监视正在质子上运行的应用程序,开发者需要服务权限 创建, (中文(简体) ), 列表, (中文(简体) ), 更新 财务报告和审定财务报表 删除 API 操作和服务实例 列表 财务报告和审定财务报表 更新 API 密码 操作.

要了解更多质子,看看 质子用户指南。 。 。 .

A. 确保有透明度

当您提出变异的 API 请求时, 请求通常会在同步工作流程之前返回结果 操作完成。 操作可能也会超时或遇到其他服务器问题,然后才会出现 完成, 即使请求已经返回结果 。 这可能使确定是否 请求成功。 此外,您可能需要多次重试请求,以确保操作 成功完成 。 然而,如果原请求和随后的再试成功,操作 发生多次。 这意味着你可能会创造出比你预期的更多的资源.

目 录 确保 API 请求的动作不超过一次。 与一个 如果初始请求动作成功完成, 任何后续重试完成 成功而不执行任何进一步的行动。 然而,结果可能包含最新资料,例如: 当前创建状态.

以下API列表按照确保一能的方法分类.

使用客户端符号创建 API

本列表中的 API 动作支持使用 idempity , 使用 a 客户签名编辑 相应的Amazon Web Services CLI命令也使用客户符支持一能. 客户代号是独一无二的, 大小写敏感字符串,最多64个ASCII字符。 利用其中一项行动,提出具有独家能力的API请求, 在请求中指定客户符。 我们建议你 别 重用同一客户端符号 其他API请求。 如果您不为这些 API 提供客户端符, 默认客户端符是自动的 由SDKs提供.

鉴于一项请求行动已取得成功:

如果您使用相同的客户端符和相同的参数重试请求,则重试不会成功 除在答复中返回原始资源细节数据外,执行任何其他行动.

如果您使用同一客户端符重试请求, 但一个或多个参数不同, 则重试 丢出一个 ValidationException 带有 IdempotentParameterMismatch 错误.

客户签名在提出请求后8小时到期。 如果您用过期的符号重试请求, 则新建 创建资源.

如果删除了原始资源, 您将重试请求, 将创建新资源 .

使用客户端符号创建 API :

• 创建环境模板

• 创建服务模板

• 创建环境账户连接

同上, 创建 API

鉴于一项请求行动已取得成功:

如果您用此组的 API 重试请求, 以及原始资源 没有 已经 修改后, 重试成功, 除了返回原始资源细节之外, 不再执行任何动作 数据在响应中.

如果修改了原始资源,则重试会丢出一个 ConflictException。 。 。 .

如果用不同的输入参数重试,则重试将丢出一个 ValidationException 带有 IdempotentParameterMismatch 错误.

同上, 创建 API :

• 创建环境模板

• 创建服务模板

• 创建环境

• 创建服务

同上,删除API

鉴于一项请求行动已取得成功:

当您用此组的 API 重试请求并删除资源时, 其元数据会返回到 反应.

如果重试且资源不存在,则回复为空.

在这两种情况下,重试都成功.

同上,删除API:

• 删除环境模板

• 删除环境模板

• 删除服务模板

• 删除服务模板

• 删除环境账户连接

同步同位素删除 API

鉴于一项请求行动已取得成功:

如果您用此组的 API 重试请求, 如果原始请求删除操作状态 DELETE_IN_PROGRESS,重试返回回复中的资源细节数据而不执行任何 进一步的行动.

如果原始请求删除操作完成,则重试返回空响应.

同步同位素删除 API :

• 删除环境

• 删除服务

安装

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

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

开始

导入

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

// ES5 example
const { ProtonClient, ListComponentsCommand } = require("@aws-sdk/client-proton");

// ES6+ example
import { ProtonClient, ListComponentsCommand } from "@aws-sdk/client-proton";

使用量

发出请求:

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

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

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

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

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

import { Proton } from "@aws-sdk/client-proton";

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

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

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

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

许可证

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

客户端命令( 操作列表)