AWS Transfer Family API リファレンス - AWS Transfer Family

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS Transfer Family API リファレンス

Transfer Family の完全な API リファレンスガイドは、 AWS Transfer Family API リファレンスで入手できます。

AWS Transfer Family は、次のプロトコルを使用して Amazon Simple Storage Service (Amazon S3) ストレージとの間でファイルを転送するために使用できる安全な転送サービスです。

  • Secure Shell (SSH) File Transfer Protocol (SFTP)

  • File Transfer Protocol Secure (FTPS)

  • File Transfer Protocol (FTP)

  • 適用性ステートメント 2 (AS2)

サーバー、ユーザー、およびロールはすべて、Amazon リソースネーム (ARN) で識別されます。ARN が含まれているエンティティにキーバリューペアであるタグを割り当てることができます。タグは、これらのエンティティのグループ化または検索に使用できるメタデータです。タグが便利な例としては、経理上の処理が挙げられます。

AWS Transfer Family ID 形式では、次の規則が適用されます。

  • ServerId 値の形式は s-01234567890abcdef です。

  • SshPublicKeyId 値の形式は key-01234567890abcdef です。

Amazon リソースネーム (ARN) は次のような形式です。

  • ユーザーの場合、ARN の形式は 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 アクションのアルファベット順リストについては、「Actions」を参照してください。

  • データ型のアルファベット順リストについては、「Types」を参照してください。

  • 共通クエリパラメータのリストについては、「共通パラメータ」を参照してください。

  • エラーコードの説明については、「共通エラー」を参照してください。

ヒント

実際にコマンドを実行する代わりに、任意の API コールで --generate-cli-skeleton パラメータを使用してパラメータテンプレートを生成して表示できます。生成されたテンプレートを使用してカスタマイズし、後のコマンドの入力として使用できます。詳細については、「パラメータスケルトンファイルを生成して使用するには」を参照してください。