本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
StartFileTransfer
开始在本地AWS存储和远程 AS2 或 SFTP 服务器之间文件传输功能。
-
对于 AS2 连接器，您可以指定
ConnectorId和一个或多个SendFilePaths来标识要传输的文件。 -
对于 SFTP 连接器，文件传输可以是出站的，也可以是入站的。在这两种情况下，您都要指定
ConnectorId。根据传输方向，您还可以指定以下项目：-
如果您要将文件从合作伙伴的 SFTP 服务器传输到 Amazon Web Services 存储，则可以指定一个或多个
RetreiveFilePaths来标识要传输的文件，并指定一个LocalDirectoryPath来指定目的地文件夹。 -
如果要将文件从AWS存储传输到合作伙伴的 SFTP 服务器，则可以指定一个或多个
SendFilePaths来标识要传输的文件，并指定一个RemoteDirectoryPath来指定目的地文件夹。
-
请求语法
{
"ConnectorId": "string",
"LocalDirectoryPath": "string",
"RemoteDirectoryPath": "string",
"RetrieveFilePaths": [ "string" ],
"SendFilePaths": [ "string" ]
}请求参数
有关所有操作的通用参数的信息，请参阅通用参数。
请求接受采用 JSON 格式的以下数据。
- ConnectorId
-
连接器的唯一标识符。
类型：字符串
长度限制：固定长度为 19。
模式：
c-([0-9a-f]{17})必需：是
- LocalDirectoryPath
-
对于入站传输，
LocaDirectoryPath指定从合作伙伴的 SFTP 服务器传输的一个或多个文件的目的地。类型：字符串
长度限制：最小长度为 1。长度上限为 1024。
模式：
(.)+必需：否
- RemoteDirectoryPath
-
对于出站传输，
RemoteDirectoryPath指定传输到合作伙伴的 SFTP 服务器的一个或多个文件的目的地。如果未指定RemoteDirectoryPath，则传输文件的目的地是 SFTP 用户的主目录。类型：字符串
长度限制：最小长度为 1。长度上限为 1024。
模式：
(.)+必需：否
- RetrieveFilePaths
-
合作伙伴的 SFTP 服务器的一个或多个源路径。每个字符串代表一次入站文件传输的源文件路径。
类型：字符串数组
数组成员：最少 1 个物品。最多 10 项。
长度限制：长度下限为 1。长度上限为 1024。
模式：
(.)+必需：否
- SendFilePaths
-
Amazon S3 存储的一个或多个源路径。每个字符串代表一次出站文件传输的源文件路径。例如，
DOC-EXAMPLE-BUCKET/myfile.txt。注意
用您的实际存储桶替换
DOC-EXAMPLE-BUCKET。类型：字符串数组
数组成员：最少 1 个物品。最多 10 项。
长度限制：长度下限为 1。长度上限为 1024。
模式：
(.)+必需：否
响应语法
{
"TransferId": "string"
}响应元素
如果此操作成功，则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- TransferId
-
返回文件传输的唯一标识符。
类型：字符串
长度限制：最小长度为 1。最大长度为 512。
模式：
[0-9a-zA-Z./-]+
错误
有关所有操作返回的常见错误的信息，请参阅常见错误。
- InternalServiceError
-
当 AWS Transfer Family服务中发生错误时，会引发此异常。
HTTP 状态代码：500
- InvalidRequestException
-
当客户端提交格式错误的请求时，会引发此异常。
HTTP 状态代码：400
- ResourceNotFoundException
-
当 AWSTransfer Family 服务找不到资源时，就会引发此异常。
HTTP 状态代码：400
- ServiceUnavailableException
-
请求失败，因为 AWSTransfer Family 服务不可用。
HTTP 状态代码：500
- ThrottlingException
-
由于请求限制而导致请求被拒绝。
HTTP 状态代码：400
示例
示例
以下示例启动从 Transfer Family 服务器到远程交易伙伴端点的 AS2 文件传输功能。用您的实际存储桶替换
DOC-EXAMPLE-BUCKET
。
示例请求
{
"ConnectorId": "c-AAAA1111BBBB2222C",
"SendFilePaths": [
"/DOC-EXAMPLE-BUCKET/myfile-1.txt",
"/DOC-EXAMPLE-BUCKET/myfile-2.txt",
"/DOC-EXAMPLE-BUCKET/myfile-3.txt"
]
}示例响应
{
"TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}示例
以下示例启动从本地AWS存储到远程 SFTP 服务器的文件传输功能。
示例请求
{
"ConnectorId": "c-01234567890abcdef",
"SendFilePaths": [
"/DOC-EXAMPLE-BUCKET/myfile-1.txt",
"/DOC-EXAMPLE-BUCKET/myfile-2.txt",
"/DOC-EXAMPLE-BUCKET/myfile-3.txt"
],
"RemoteDirectoryPath": "/MySFTPRootFolder/fromTranferFamilyServer"
}示例响应
{
"TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}示例
以下示例启动从远程 SFTP 服务器到本地AWS存储的文件传输功能。
示例请求
{
"ConnectorId": "c-111122223333AAAAA",
"RetrieveFilePaths": [
"/MySFTPFolder/toTranferFamily/myfile-1.txt",
"/MySFTPFolder/toTranferFamily/myfile-2.txt",
"/MySFTPFolder/toTranferFamily/myfile-3.txt"
],
"LocalDirectoryPath": "/DOC-EXAMPLE-BUCKET/mySourceFiles"
}示例响应
{
"TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa"
}另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
