API 参考 - Amazon Transfer Family
欢迎使用
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

API 参考

以下各节记录了 Amazon Transfer Family API 服务调用、数据类型、参数和错误。

主题

欢迎使用 Amazon Transfer Family API

Amazon Transfer Family 是一项安全的传输服务，您可以使用它通过以下协议将文件传入和传出亚马逊简单存储服务 (Amazon S3) Storage Service 存储：

  • Secure Shell (SSH) 文件传输协议 (SFTP)

  • 安全文件传输协议 (FTPS)

  • 文件传输协议 (FTP)

  • 适用性声明 2 (AS2)

文件传输协议用于金融服务、医疗保健、广告和零售等不同行业的数据交换工作流程。 Amazon Transfer Family 简化了将文件传输工作流迁移到 Amazon。

要使用该 Amazon Transfer Family 服务，您需要在您选择的 Amazon 区域中实例化服务器。您可以创建服务器，列出可用服务器，并更新和删除服务器。服务器是向其请求文件操作的实体 Amazon Transfer Family。服务器有许多重要的属性。服务器是由系统分配的 ServerId 标识符所标识的命名实例。您可以选择为服务器分配主机名，甚至分配自定义主机名。该服务针对任何实例化的服务器（即使服务器处于 OFFLINE 状态）以及传输的数据量进行收费。

用户必须知道请求文件操作的服务器。由用户名标识的用户被分配给服务器。用户名用于对请求进行身份验证。一个服务器只能有一个身份验证方法，即 AWS_DIRECTORY_SERVICE、SERVICE_MANAGED、AWS_LAMBDA、或 API_GATEWAY.

您可以使用以下任何一种身份提供程序类型来对用户进行身份验证：

  • 对于 SERVICE_MANAGED，SSH 公有密钥与服务器上的用户属性一起存储。用户可以拥有文件的一个或多个 SSH 公有密钥，用于 SERVICE_MANAGED 身份验证方法。当客户端请求 SERVICE_MANAGED 方法的文件操作时，客户端提供用户名和 SSH 私有密钥，该私有密钥经过身份验证并提供访问权限。

  • 您可以通过选择AWS_DIRECTORY_SERVICE身份验证方法来管理用户对 Microsoft Active Directory 组的身份验证和访问权限。

  • 您可以使用连接到自定义身份提供商 Amazon Lambda。选择AWS_LAMBDA身份验证方法。

  • 您还可以使用提供用户身份验证和访问的自定义身份验证方法对用户请求进行身份验证。此方法依赖于 Amazon API Gateway 来使用您身份提供商的 API 调用对用户请求进行身份验证。此方法在 API 调用中称为 API_GATEWAY，在控制台中称为 自定义。您可以使用此自定义方法根据目录服务、数据库名称/密码对或其他某个机制对用户进行身份验证。

为用户分配一个策略，该策略在用户与 Amazon S3 存储桶之间具有信任关系。用户可能能够访问全部或部分存储桶。为了使服务器代表用户，服务器必须从用户继承信任关系。创建一个包含信任关系的 Amazon Identity and Access Management (IAM) 角色，并为该角色分配 AssumeRole 操作。然后，服务器可以像用户一样执行文件操作。

具有 home 目录属性集的用户将使该目录（或文件夹）充当文件操作的目标和源。如果未设置 home 目录，则存储桶的 root 目录将成为登录目录。

服务器、用户和角色均由其 Amazon 资源名称 (ARN) 标识。您可以为具有 ARN 的实体分配标签（键值对）。标签是可用于分组或搜索这些实体的元数据。标签有用的一个例子是用于会计目的。

在 Amazon Transfer Family ID 格式中遵守以下惯例：

  • ServerId 值采用 s-01234567890abcdef 形式。

  • SshPublicKeyId 值采用 key-01234567890abcdef 形式。

Amazon 资源名称 (ARN) 格式采用以下形式：

  • 对于服务器，ARN 采用 arn:aws:transfer:region:account-id:server/server-id 形式。

    服务器 ARN 的示例是：arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef。

  • 对于用户，ARN 采用 arn:aws:transfer:region:account-id:user/server-id/username 形式。

    例如，arn:aws:transfer:us-east-1:123456789012:user/s-01234567890abcdef/user1。

正在使用的 DNS 条目（端点）如下所示：

  • API 终端节点采用 transfer.region.amazonaws.com 形式。

  • 服务器终端节点采用 server.transfer.region.amazonaws.com 形式。

有关按 Amazon 地区划分的 Transfer Family 终端节点列表，请参阅中的Amazon Transfer Family 终端节点和配额Amazon Web Services 一般参考。

此 API 接口参考 Amazon Transfer Family 包含可用于管理的编程接口的文档 Amazon Transfer Family。参考结构如下所示：

  • 有关 API 操作的字母顺序列表，请参阅Actions。

  • 有关数据类型的字母顺序列表，请参阅Data Types。

  • 有关常用查询参数的列表，请参阅常用参数。

  • 有关错误代码的描述，请参阅常见错误。

提示

您可以将--generate-cli-skeleton参数与任何 API 调用一起使用来生成和显示参数模板，而不是实际运行命令。然后，您可以使用生成的模板进行自定义，并将其用作后续命令的输入。有关详细信息，请参阅生成并使用参数骨架文件。