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

# AWS Transfer Family API 參考
<a name="api-welcome"></a>

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

AWS Transfer Family 是一種安全傳輸服務，可讓您透過下列通訊協定，將檔案傳入和傳出 Amazon Simple Storage Service (Amazon S3) 儲存體：
+ 安全殼層 (SSH) 檔案傳輸通訊協定 (SFTP)
+ 檔案傳輸通訊協定安全 (FTPS)
+ 檔案傳輸通訊協定 (FTP)
+ 適用性聲明 2 (AS2)

伺服器、使用者和角色都由其 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`。
+ 針對使用者，ARN 採用 `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)。

**提示**  
您可以搭配任何 API 呼叫使用 `--generate-cli-skeleton` 參數來產生和顯示參數範本，而不是實際執行命令。然後，您可以使用產生的範本來自訂和使用 做為稍後命令的輸入。如需詳細資訊，請參閱[產生和使用參數骨架檔案](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate)。