API リファレンス

以下のセクションでは、 AWS Transfer Family API サービスの呼び出し、データ型、パラメータ、エラーについて説明します。

トピック

• AWS Transfer Family API へようこそ
• アクション
• データ型
• 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)

ファイル転送プロトコルは、金融サービス、医療、広告、小売など、さまざまな業界のデータ交換ワークフローで使用されます。 AWS Transfer Family は、ファイル転送ワークフローの への移行を簡素化します AWS。

AWS Transfer Family サービスを使用するには、選択した AWS リージョンでサーバーをインスタンス化します。サーバーを作成して、使用可能なサーバーを一覧表示し、サーバーを更新および削除できます。サーバーは、 からファイルオペレーションをリクエストするエンティティです AWS Transfer Family。サーバーには、多くの重要なプロパティが含まれています。サーバーは、システムにより割り当てられた ServerId 識別子によって識別される名前付きインスタンスです。必要に応じて、ホスト名や、カスタムホスト名もサーバーに割り当てることができます。サービスの使用料は、すべてのインスタンス化されたサーバー (OFFLINE も含む) および転送されたデータの量に従って請求されます。

ファイルオペレーションをリクエストするサーバーがユーザーを認識している必要があります。ユーザー名によって識別されるユーザーがサーバーに割り当てられます。ユーザー名は、リクエストの認証に使用されます。サーバーの認証方法となりうるのは、AWS_DIRECTORY_SERVICE、SERVICE_MANAGED、AWS_LAMBDA、または API_GATEWAY のいずれかです。

次のいずれかの ID プロバイダーのタイプを使用して、ユーザーを認証できます。

• SERVICE_MANAGED の場合は、SSH パブリックキーはサーバーにユーザーのプロパティとともに保存されます。ユーザーは、SERVICE_MANAGED 認証方法に 1 つ以上の SSH パブリックキーを登録できます。クライアントが SERVICE_MANAGED メソッドのファイルオペレーションをリクエストする場合、クライアントがユーザー名とSSH プライベートキーを提供することで、認証され、アクセスが提供されます。

• AWS_DIRECTORY_SERVICE 認証方法を選択することで、Microsoft Active Directory グループでのユーザー認証とアクセスを管理できます。

• を使用してカスタム ID プロバイダーに接続できます AWS Lambda。AWS_LAMBDA 認証方法を選択します。

• ユーザー認証とアクセスの両方を提供するカスタム認証方法を使用すると、ユーザーリクエストも認証できます。このメソッドは Amazon API Gateway に依存しており、ID プロバイダーからの API コールを使用して、ユーザーリクエストを検証します。このメソッドは、API コールでは API_GATEWAY と呼ばれ、コンソールでは [Custom] と呼ばれます。このカスタムメソッドを使用して、ディレクトリサービス、データベース名とパスワードのペア、またはその他のメカニズムに対してユーザーを認証できる場合があります。

ユーザーには、ユーザー自身と Amazon S3 バケットの間の信頼関係が含まれたポリシーが割り当てられます。SFTP ユーザーは、バケットのすべてまたは一部にアクセスできる可能性があります。サーバーがユーザーに代わって機能するためには、サーバーがユーザーから信頼関係を継承する必要があります。信頼関係を含んでいる AWS Identity and Access Management (IAM) ロールが作成され、そのロールが AssumeRole アクションに割り当てられます。サーバーは、ユーザーであるかのようにファイルオペレーションを実行できるようになります。

home ディレクトリのプロパティセットを持つユーザーの場合、そのディレクトリ (またはフォルダ) はファイルオペレーションのターゲットおよびソースとして機能します。home ディレクトリが設定されていない場合は、バケットの root ディレクトリがランディングディレクトリになります。

サーバー、ユーザー、およびロールはすべて、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 です。

AWS リージョン別の Transfer Family エンドポイントのリストについては、「」のAWS Transfer Family 「 エンドポイントとクォータ」を参照してくださいAWS 全般のリファレンス。

のこの API インターフェイスリファレンスには、 の管理に使用できるプログラミングインターフェイスのドキュメント AWS Transfer Family が含まれています AWS Transfer Family。リファレンス構造は次のとおりです。

• API アクションのアルファベット順リストについては、「Actions」を参照してください。

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

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

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

ヒント

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