API 參考 - AWS Transfer Family
歡迎

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

API 參考

下列各節記錄 AWS Transfer Family API服務呼叫、資料類型、參數和錯誤。

主題

歡迎使用 AWS Transfer Family API

AWS Transfer Family 是一項安全傳輸服務，可讓您透過下列通訊協定，在 Amazon Simple Storage Service （Amazon S3） 儲存體中來回傳輸檔案：

  • 安全殼層 （SSH） 檔案傳輸通訊協定 （SFTP）

  • 檔案傳輸通訊協定安全 （FTPS）

  • 檔案傳輸通訊協定 （FTP）

  • 適用性聲明 2 （AS2）

檔案傳輸通訊協定用於金融服務、醫療保健、廣告和零售等不同產業的資料交換工作流程。 AWS Transfer Family 可簡化檔案傳輸工作流程遷移至 的過程 AWS。

若要使用 AWS Transfer Family 服務，您可以在您選擇的 AWS 區域中初始化伺服器。您可以建立伺服器、列出可用的伺服器，以及更新和刪除伺服器。伺服器是向 請求檔案操作的實體 AWS Transfer Family。伺服器有多項重要屬性。伺服器是具名的執行個體，由系統指派的 ServerId 識別符來識別。您可以選擇將主機名稱，甚至自訂主機名稱指派給伺服器。任何具現化伺服器 （甚至是 OFFLINE） 的服務帳單，以及傳輸的資料量。

請求檔案操作的伺服器必須知道使用者。使用者會由使用者名稱來識別，並指派給伺服器。使用者名稱用於驗證請求。伺服器只能有一個身分驗證方法：AWS_DIRECTORY_SERVICE、AWS_LAMBDA、 SERVICE_MANAGED或 API_GATEWAY。

您可以使用下列任一身分提供者類型來驗證使用者：

  • 對於 SERVICE_MANAGED，SSH公有金鑰會與使用者屬性存放在伺服器上。使用者可以在檔案中有一或多個SSH公有金鑰，用於SERVICE_MANAGED身分驗證方法。當用戶端請求SERVICE_MANAGED方法的檔案操作時，用戶端會提供使用者名稱和SSH私有金鑰，該金鑰已驗證，並提供存取權。

  • 您可以透過選取身分驗證方法，使用 Microsoft Active Directory 群組管理使用者AWS_DIRECTORY_SERVICE身分驗證和存取。

  • 您可以使用 連線到自訂身分提供者 AWS Lambda。選擇AWS_LAMBDA身分驗證方法。

  • 您也可以使用自訂的身分驗證方法來驗證使用者請求，以同時提供使用者身分驗證和存取權。此方法依賴 Amazon API Gateway 使用來自身分提供者的API呼叫來驗證使用者請求。此方法在API通話API_GATEWAY中稱為 ，在主控台中稱為 Custom。您可以使用自訂方法，藉由目錄服務、資料庫名稱/密碼對，或一些其他機制來驗證使用者。

使用者會被指派一個政策，其自身與 Amazon S3 儲存貯體之間具有信任關係。他們可以存取部分或所有儲存貯體。若要讓伺服器代表使用者行事，伺服器必須繼承使用者的信任關係。建立包含信任關係的 AWS Identity and Access Management （IAM） 角色，該角色會獲指派AssumeRole動作。然後，伺服器可以像使用者一樣執行檔案操作。

具有home目錄屬性集的使用者，該目錄 （或資料夾） 將作為檔案操作的目標和來源。如果未設定任何 home 目錄，儲存貯體的 root 目錄就會變成登陸目錄。

伺服器、使用者和角色都由其 Amazon Resource Name （） 識別ARN。您可以將鍵值對的標籤指派給具有 的實體ARN。標籤是可用於分組或搜尋這些實體的中繼資料。舉例來說，標籤在會計用途方面就非常有用。

下列慣例是以 AWS Transfer Family ID 格式觀察到的：

  • ServerId 值採用 s-01234567890abcdef 的形式。

  • SshPublicKeyId 值採用 key-01234567890abcdef 的形式。

Amazon Resource Name （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 的形式。

如需依 AWS 區域劃分的 Transfer Family 端點清單，請參閱中的AWS Transfer Family 端點和配額AWS 一般參考。

的此API介面參考 AWS Transfer Family 包含程式設計介面的文件，可用於管理 AWS Transfer Family。參考結構如下：

  • 如需API動作的字母順序清單，請參閱 Actions.

  • 如需資料類型的字母順序清單，請參閱 Data Types.

  • 如需常用查詢參數的清單，請參閱常用參數。

  • 如需錯誤碼的說明，請參閱常見錯誤。

提示

與其實際執行 命令，您可以搭配任何API呼叫使用 --generate-cli-skeleton 參數來產生和顯示參數範本。然後，您可以使用產生的範本來自訂和使用 作為後續命令的輸入。如需詳細資訊，請參閱產生和使用參數骨架檔案 。