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

# AWS Transfer Family API 参考
API 参考资料

Transfer Family 的完整 API 参考指南可在 [AWS Transfer Family API 参考](https://docs.aws.amazon.com/transfer/latest/APIReference/api-welcome.html)中找到。

AWS Transfer Family 是一项安全的传输服务，您可以使用它通过以下协议将文件传入和传出亚马逊简单存储服务 (Amazon S3) Storage Service 存储：
+ Secure Shell (SSH) 文件传输协议 (SFTP)
+ 安全文件传输协议 (FTPS)
+ 文件传输协议 (FTP)
+ 适用性声明 2 (AS2)

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

在 AWS Transfer Family ID 格式中应遵守以下惯例：
+ `ServerId` 值采用 `s-01234567890abcdef` 形式。
+ `SshPublicKeyId` 值采用 `key-01234567890abcdef` 形式。

Amazon 资源名称 (ARN) 格式采用以下形式：
+ 对于服务器， ARNs 请使用表格`arn:aws:transfer:region:account-id:server/server-id`。

  服务器 ARN 的示例是：`arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef`。
+ 对于用户， ARNs 请填写表格`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` 形式。

此 API 接口参考 AWS Transfer Family 包含可用于管理的编程接口的文档 AWS Transfer Family。参考结构如下所示：
+ 有关按字母顺序排列的 API 操作列表，请参阅 [https://docs.aws.amazon.com/transfer/latest/APIReference/API_Operations.html](https://docs.aws.amazon.com/transfer/latest/APIReference/API_Operations.html).
+ 有关按字母顺序排列的数据类型列表，请参见 [https://docs.aws.amazon.com/transfer/latest/APIReference/API_Types.html](https://docs.aws.amazon.com/transfer/latest/APIReference/API_Types.html).
+ 有关常用查询参数的列表，请参阅[常用参数](https://docs.aws.amazon.com/transfer/latest/APIReference/CommonParameters.html)。
+ 有关错误代码的描述，请参阅[常见错误](https://docs.aws.amazon.com/transfer/latest/APIReference/CommonErrors.html)。

**提示**  
您可以将 `--generate-cli-skeleton` 参数与任何 API 调用一起使用来生成和显示参数模板，而不是实际运行命令。然后，您可以使用生成的模板进行自定义，并将其用作后续命令的输入。有关详细信息，请参阅[生成并使用参数骨架文件](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate)。