@aws-sdk/ 客户- 传输

说明

用于节点.js的JavaScript传输客户端的AWS SDK,浏览器和React Introduct.

Transfer Family为通过SFTP,AS2,FTPS,FTP,以及基于网络浏览器的传输直接进出亚马逊Web Services存储服务提供完全管理的支持.

文件传输协议被用于金融服务、医疗保健、广告和零售等不同行业的数据交换工作流程。 转移家庭简化了文件传输工作流程向亚马逊网络服务的迁移.

要使用转移家庭服务,请立即在您选择的亚马逊网络服务区安装一个服务器。 您可以创建服务器,列出可用的服务器,并更新和删除服务器. 服务器是从 Transfer Family 请求文件操作的实体. 服务器有一些重要属性. 服务器是指定系统识别的已命名实例 ServerId 标识符。 您可以选择为服务器指定主机名,甚至自定义的主机名. 任何即时服务器的服务账单(甚至包括 OFFLINE),以及数据传输量.

请求文件操作的服务器必须知道用户. 由用户名识别的用户被分配到服务器. 用户名用于认证请求. 服务器只能有一个认证方法: AWS_DIRECTORY_SERVICE, (中文(简体) ), SERVICE_MANAGED, (中文(简体) ), AWS_LAMBDA,或 API_GATEWAY。 。 。 .

Transfer Family也支持提供基于浏览器的文件传输能力的网络应用程序. 网络应用程序可以用 VPC 端点来配置,以便在您的虚拟私人云(VPC)内部实现安全的,私有的连接. 这使得您能够通过您的 VPC 基础设施控制网络访问和线路交通,同时保持转移家庭的管理收益.

这个用于 Transfer Family的API接口引用包含了用于管理 Transfer Family的编程接口的文档. 参考结构如下:

• 关于API动作的字母列表,请参见.

• 数据类型的字母列表见.

• 常见查询参数列表见: 通用参数。 。 。 .

• 关于错误代码的说明,参见: 常见错误。 。 。 .

与其实际运行命令,不如使用 --generate-cli-skeleton 带有任何 API 调用以生成和显示参数模板的参数。 然后,您可以使用生成的模板自定义并用作以后命令的输入. 详情见 生成并使用参数骨架文件。 。 。 .

安装

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

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

开始

导入

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

// ES5 example
const { TransferClient, ListServersCommand } = require("@aws-sdk/client-transfer");

// ES6+ example
import { TransferClient, ListServersCommand } from "@aws-sdk/client-transfer";

使用量

发出请求:

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

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

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

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

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

import { Transfer } from "@aws-sdk/client-transfer";

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

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

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

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

许可证

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

客户端命令( 操作列表)