API Gateway 経由で Amazon S3 に画像ファイルをアップロードするにはどうすればよいですか?

最終更新日: 2021 年 12 月 9 日

Amazon API Gateway 経由で Amazon Simple Storage Service (Amazon S3) に画像ファイルをアップロードしたいと考えています。どうすればよいですか?

簡単な説明

API Gateway を使用して S3 バケットにバイナリファイル(画像)をアップロードするには、API Gateway REST API のバイナリサポートを有効にする必要があります。

API が S3 バケットにアクセスできるようにするには、AWS Identity and Access Management (IAM) ロールを作成する必要もあります。IAM ロールには、API Gateway が S3 バケットで PutObject アクションを実行するためのアクセス許可が含まれている必要があります。

解決方法

API Gateway の IAM ロールを作成する

  1. [IAM コンソール] を開きます。
  2. ナビゲーションペインで、[ロール] を選択します。
  3. [ロールの作成] を選択します。
  4. [Select type of trusted entity] セクションで、[AWS service] を選択します。
  5. [Choose a use case] で、[API Gateway] を選択します。
  6. [Select your use case] セクションで、[API Gateway] を選択します。
  7. [Next: Permissions] を選択します。
    注: このセクションでは、API Gateway がユーザーのアカウントにログをプッシュすることを許可する AWS managed service を表示します。S3 のアクセス許可は後で追加します。[ Next: Tags ] を選択します。
  8. (オプション) タグを追加し、続いて [Next: Review] を選択します。
  9. [Role name] に、ポリシーの名前を入力します。例: api-gateway-S3 へアップロード
  10. [ロールの作成] を選択します。

IAM ポリシーを作成して API Gateway ロールにアタッチする

  1. [IAM コンソール] を開きます。
  2. ナビゲーションペインで、[ロール] を選択します。
  3. 検索ボックスに、作成した新しい API Gateway ロールの名前を入力します。次に、[Role name] 列からそのロールを選択します 。
  4. [Permissions ] タブで、[Attach policcies] を選択します。
  5. [Create policy] を選択します。
  6. [Visual editor ] タブの [ Select a service ] ( サービスの選択 ) セクションで、[ Choose a service ] ( サービスの選択 ) を選択します 。
  7. [S3 ]と入力し、[ S3 ] を選択します。
  8. [ S3 で許可されるアクションを指定する ] ボックスに「 PutObject 」と入力し、[ PutObject ] を選択します。
  9. [ Resources ] を展開し、[Specific] を選択します。
  10. [Add ARN] を選択します。
  11. [ Bucket name ] に、バケットの名前を入力します。該当する場合、PreFix を含めてください。
  12. [ Object name ] に、オブジェクト名を入力します。
    注: バケット名は、アップロードされたファイルの場所を指定します。オブジェクト名は、オブジェクト (つまり、ファイル名) がポリシー調整のために遵守しなければならないパターンを指定します。
  13. [Add] を選択します。
  14. [Next: Tags] を選択し、(オプション) タグを追加し、続いて [Next: Review] を選択します。
  15. [ 名前 ] に、ポリシーの名前を入力します。
  16. [Create policy] を選択します。
  17. ポリシー検索ボックスで、前に作成したポリシーの名前を入力し、そのポリシーを選択します。
  18. [ポリシーアクション] を選択して、 [アタッチ] を選択します。IAM ロールのリストが表示されます。
  19. 前に作成した API Gateway ロールを検索し、そのロールを選択します。
  20. [ポリシーのアタッチ] を選択します。

API Gateway REST API を作成する

リクエストを処理する API を作成する

  1. API Gateway コンソールにログインします。
  2. ナビゲーションペインで、[APIs] を選択します。
  3. [Create API] を選択します。
  4. [ Choose an API type ] セクションで、[Build for REST API] を選択します。
  5. [API Name] に API の名前を入力し、[Next] を選択します。
  6. [Create API] を選択します。

API のリソースを作成する

  1. API ページの [Resources] パネルで、[/] を選択します。
  2. [Actions] で、[Create Resource] を選択します。
  3. [Resource Name] に、[floder] を入力します。
  4. [Resource Path] に、{folder} を入力します。
  5. [リソースの作成] を選択します。
  6. Resourcesパネルで、先ほど作成した /{folder} リソースを選択します。
  7. [Actions] を選択してから、[Create Resource]を選択します。
  8. [Resource Name] に、[object] を入力します。
  9. [Resource Path] に、{object} を入力します。
  10. [リソースの作成] を選択します。

API の PUT メソッドを作成する

  1. API ページの [ Resources ] パネルで、[/{object}] を選択します。
  2. [Actions]を選択してから、[Create Method] を選択します。
  3. ドロップダウンメニューから [PUT] を選択し、チェックマークアイコンを選択します。
  4. コンソールの制限により、オプションが 3 つしか表示されない場合があります。この制限を回避するには、利用可能な統合タイプを一時的に設定し、後でAWS のサービスへの統合リクエストのエンドポイントを編集します。例えば、[Integration type] で [HTTP Proxy] を選択します。次に、[Endpoint URL] に https://postman-echo.com/get と入力します (「パラメータがありません:{proxy}」という警告は無視してください)。[Save] をクリックして変更を保存します。
  5. 次に、[Integration Request] を選択し、[Integration type] カテゴリで [AWS Service] を選択します。
  6. [AWS Region] では、[us-west-2] を選択します。
  7. [AWS Service] は 、[Simple Storage Service (S3)] を選択します。
  8. [AWS Subdomain] は空欄のままにします。
  9. [HTTP method] は、[PUT] を選択します。
  10. [ Action Type ] は、[ Use path override] を選択します。
  11. [ Path override (optional) ] は、 {bucket}/{key} と入力します。
  12. [ Execution role ] には、前に作成した IAM ロールの Amazon リソースネーム (ARN) を入力します。
  13. [ Content Handling ] は、[ Passthrough ] を選択します。
  14. [Save] を選択します。

PUT メソッドのパラメータマッピングを設定する

  1. API ページの [Resources] パネルで、[PUT] を選択します。
  2. [Integration Request] を選択します。
  3. [ URL Path Parameters ] を展開します。
  4. [ Add path] を選択します。
  5. [Name] に[buket] を入力します。
  6. [Mapped from] に method.request.path.folder を入力します。
  7. 行の最後にあるチェックマークアイコンを選択します。
  8. 手順 4 ~ 7 を繰り返します。手順 5 、[ Name ] を [key ] に設定します。手順 6 、 Mapped from method.request.path.objectを設定します。

API のバイナリメディアタイプを設定する

  1. API ページのナビゲーションペインで、[ Settings ] を選択します。
  2. [ Binary Media Types ] セクションで、[ Add Binary Media Type] を選択します。
  3. テキストボックスに、次の文字列を追加します: */*
    注: 文字列を引用符で囲まないようにしてください。バイナリメディアタイプとして扱いたい特定の MIME タイプをワイルドカードで代用することができます。たとえば、「image/jpeg」 を選択すると、API Gateway で JPEG 画像がバイナリメディアタイプとして扱われます。*/* を追加すると、API Gateway はすべてのメディアタイプをバイナリメディアタイプとして扱います。
  4. [Save changes] を選択します。

API をデプロイする

  1. API ページのナビゲーションペインで、[ Resources ] を選択します。
  2. [Resources] ペインで、[Actions]、[Deploy API] の順にクリックします。
  3. [Deploy API] ウィンドウの [Deployment stage] で、[New Stage] を選択します。
  4. [Stage name] に、v1 と入力します。
  5. [Deploy] を選択します。
  6. ナビゲーションペインで、[Stages] を選択します。
  7. v1 ステージを選択します。これで、デプロイされた API スナップショットへのリクエストを実行するための呼び出し URL が表示されます。
  8. [Invoke URL] をコピーしておきます。

注: 詳細については、「Amazon API Gateway での REST API のデプロイ」を参照してください。

API を呼び出してイメージファイルを S3 にアップロードする

API の呼び出し URL に、オブジェクトのバケット名とファイル名を追加します。次に、任意のクライアントを使用して PUT HTTP リクエストを作成します。例えば、Postman アプリケーションです。

詳細については、「Amazon API Gateway での REST API の呼び出し」を参照してください。

PUT メソッドの HTTP リクエストの例

注: この例では、abc が API ID、mybucket が S3 バケット、myobject.jpeg がアップロードするローカルファイルであると仮定します。この例では、mybucket{folder} に置き換えられて {bucket} にマッピングされ、myobject.jpeg{object} に置き換えられ、{key} にマッピングされます。

https://abc.execute-api.ap-southeast-1.amazonaws.com/v1/mybucket/myobject.jpeg

重要: バイナリリストに */* が含まれている場合は、ファイルをアップロードするために PUT リクエストを行うことができます。バイナリリストに image.jpeg が含まれている場合は、Content-Type header をPUT リクエストに追加する必要があります。Content-Type header image/jpeg に設定する必要があります。


この記事はお役に立ちましたか?


請求に関するサポートまたは技術サポートが必要ですか?