How to integrate API Gateway to S3 Service using Action Type as Action Name PutObject

You can try these steps:

1. Create an IAM Role for the API Gateway:

   • Create an IAM role that grants the necessary permissions for API Gateway to access the S3 bucket.
   • Attach a policy that allows the s3:PutObject action on the desired S3 bucket.

2. Configure the API Gateway Integration Request:

   • In the API Gateway console, create a new API or navigate to an existing one.
   • Add a new resource with the path /upload.
   • Create a new method for the /upload resource, and select POST as the HTTP method.
   • In the method setup, choose Integration Type as AWS.
   • For AWS Service, select S3.
   • For AWS Action, select PutObject.
   • In the Integration Request section:
     • Integration URI: Set the Integration URI to the following format: arn:aws:apigateway:{region}:s3:path/{bucket}/{object_key}
       • Replace {region} with the AWS region where your S3 bucket is located.
       • Replace {bucket} with the name of your S3 bucket.
       • {object_key} will be the placeholder for the object key that you'll pass from the client.
     • Mapping Templates: Add a mapping template for the application/json content type. In the template, you can define the object key that will be used for the PutObject action. For example:

       {
         "key": "$input.path('$.objectKey')"
       }

       This maps the objectKey property from the client's request body to the key parameter in the PutObject action.

3. Configure the API Gateway Method Request:

   • In the Method Request section, add a new Request Body parameter with the name objectKey (or any other name you prefer).
   • Set the Model to Method Request and the Required field to true.

4. Deploy the API Gateway:

   • After configuring the integration, you need to deploy the API Gateway.
   • In the API Gateway console, go to the Stages section and create a new stage (e.g., dev, prod) or use an existing one.
   • Deploy the API to the selected stage.

Now, when a client sends a POST request to the /upload resource, the API Gateway will forward the request to the S3 service, using the PutObject action and the objectKey value from the request body.

Here's an example of how the client can make a request to the API Gateway:

{
  "objectKey": "example-file.txt"
}

The API Gateway will then use the provided objectKey value to construct the PutObject request and upload the file to the specified S3 bucket.

Hi,

There is a great knowledge article to help you upload files to S3 using API Gateway, I am sure, you would find an approach from that.

Hope this helps!

Thanks, Rama