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

API リファレンス

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

へようこそ AWS Transfer Family API

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

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

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

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

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

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

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

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

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

Amazon リソースネーム (ARN) 形式は、次の形式になります。

DNS 使用中のエントリ (エンドポイント) は次のとおりです。

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

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