本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
StartFileTransfer
開始本機 AWS 儲存與遠端 AS2 或 SFTP 伺服器之間的檔案傳輸。
-
對於 AS2 連接器，您可以指定
ConnectorId和一個或多個SendFilePaths以識別要傳輸的檔案。 -
對於 SFTP 連接器，檔案傳輸可以是輸出或輸入。在這兩種情況下，您都可以指定
ConnectorId. 根據轉移方向，您也可以指定下列項目：-
如果要將檔案從合作夥伴的 SFTP 伺服器傳輸到 Amazon Web Services 儲存體，請指定一個或多個用於識別
RetrieveFilePaths要傳輸的檔案，並指LocalDirectoryPath定目標資料夾。 -
如果您要從 AWS 儲存裝置傳輸檔案至協力廠商的 SFTP 伺服器，您可以指定一或多個
SendFilePaths來識別您要傳輸的檔案，並指RemoteDirectoryPath定目的地資料夾。
-
請求語法
{
"ConnectorId": "string",
"LocalDirectoryPath": "string",
"RemoteDirectoryPath": "string",
"RetrieveFilePaths": [ "string" ],
"SendFilePaths": [ "string" ]
}請求參數
如需所有動作的一般參數資訊，請參閱《Common Parameters》。
請求接受採用 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
-
當 AWS Transfer Family 服務找不到資源時，會擲回此例外狀況。
HTTP 狀態碼：400
- ServiceUnavailableException
-
申請失敗，因為 AWS Transfer 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 的詳細資訊，請參閱下列內容：
