本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
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" ]
}請求參數
如需所有動作的一般參數資訊，請參閱《Common Parameters》。
請求接受下列JSON格式的資料。
- ConnectorId
-
連接器的唯一識別符。
類型：字串
長度限制條件：固定長度為 19。
模式：
c-([0-9a-f]{17})必要：是
- LocalDirectoryPath
-
對於傳入傳輸， 會為一或多個從合作夥伴的SFTP伺服器傳輸的檔案
LocaDirectoryPath指定目的地。類型：字串
長度限制：長度下限為 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
範例
範例
下列範例會開始將AS2檔案從 Transfer Family 伺服器傳輸至遠端交易合作夥伴的端點。 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"
}另請參閱
如需在其中一種語言特定 API中使用此功能的詳細資訊 AWS SDKs，請參閱下列內容：
