Tutorial: Build an API Gateway REST API with Amazon integration

1. Complete the steps in Prerequisites for getting started with API Gateway.

2. Create a new API named MyDemoAPI. For more information, see Tutorial: Build a REST API with HTTP non-proxy integration.

3. Deploy the API at least once to a stage named test. For more information, see Deploy the API in Build an API Gateway REST API with Lambda integration.

4. Complete the rest of the steps in Build an API Gateway REST API with Lambda integration.

5. Create at least one topic in Amazon Simple Notification Service (Amazon SNS). You will use the deployed API to get a list of topics in Amazon SNS that are associated with your Amazon account. To learn how to create a topic in Amazon SNS, see Create a Topic. (You do not need to copy the topic ARN mentioned in step 5.)

To create the Amazon service proxy execution role

1. Sign in to the Amazon Web Services Management Console and open the IAM console at https://console.amazonaws.cn/iam/.

2. Choose Roles.

3. Choose Create role.

4. Choose Amazon service under Select type of trusted entity, and then select API Gateway and select Allows API Gateway to push logs to CloudWatch Logs.

5. Choose Next, and then choose Next.

6. For Role name, enter APIGatewaySNSProxyPolicy, and then choose Create role.

7. In the Roles list, choose the role you just created. You may need to scroll or use the search bar to find the role.

8. For the selected role, select the Add permissions tab.

9. Choose Attach policies from the dropdown list.

10. In the search bar, enter AmazonSNSReadOnlyAccess and choose Add permissions.

    Note

    This tutorial uses a managed policy for simplicity. As a best practice, you should create your own IAM policy to grant the minimum permissions required.

11. Note the newly created Role ARN, you will use it later.

To create the resource

1. Sign in to the API Gateway console at https://console.amazonaws.cn/apigateway.

2. Choose your API.

3. Select the root resource, /, represented by a single forward slash (/), and then choose Create resource.

4. Keep Proxy resource turned off.

5. Keep Resource path as /.

6. For Resource name, enter mydemoawsproxy.

7. Keep CORS (Cross Origin Resource Sharing) turned off.

8. Choose Create resource.

To create the GET method

1. Select the /mydemoawsproxy resource, and then choose Create method.

2. For method type, select GET.

3. For Integration type, select Amazon Web Service.

4. For Amazon Web Services Region, select the Amazon Web Services Region where you created your Amazon SNS topic.

5. For Amazon Web Service, select Amazon SNS.

6. Keep Amazon subdomain blank.

7. For HTTP method, select GET.

8. For Action type, select Use action name.

9. For Action name, enter ListTopics.

10. For Execution role, enter the role ARN for APIGatewaySNSProxyPolicy.

11. Choose Create method.

To test the GET method

1. Choose the Test tab. You might need to choose the right arrow button to show the tab.

2. Choose Test.

   The result displays response similar to the following:

   {
     "ListTopicsResponse": {
       "ListTopicsResult": {
         "NextToken": null,
         "Topics": [
           {
             "TopicArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MySNSTopic-1"
           },
           {
             "TopicArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MySNSTopic-2"
           },
           ...
           {
             "TopicArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MySNSTopic-N"
           }
         ]
       },
       "ResponseMetadata": {
         "RequestId": "abc1de23-45fa-6789-b0c1-d2e345fa6b78"
       }
     }
   }

To deploy the API

1. Choose Deploy API.

2. For Stage, select New stage.

3. For Stage name, enter test.

4. (Optional) For Description, enter a description.

5. Choose Deploy.

1. In the main navigation pane, choose Stage.

2. Under Stage details, choose the copy icon to copy your API's invoke URL.

   It should look like this:

   https://my-api-id.execute-api.region-id.amazonaws.com/test

3. Enter the URL into the address box of a new browser tab.

4. Append /mydemoawsproxy so that the URL looks like this:

   https://my-api-id.execute-api.region-id.amazonaws.com/test/mydemoawsproxy

   Browse to the URL. Information similar to the following should be displayed:

   {"ListTopicsResponse":{"ListTopicsResult":{"NextToken": null,"Topics":[{"TopicArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MySNSTopic-1"},{"TopicArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MySNSTopic-2"},...{"TopicArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MySNSTopic-N}]},"ResponseMetadata":{"RequestId":"abc1de23-45fa-6789-b0c1-d2e345fa6b78}}}

To delete the associated IAM resources

1. Open the IAM console at https://console.amazonaws.cn/iam/.

2. In the Details area, choose Roles.

3. Select APIGatewayAWSProxyExecRole, and then choose Role Actions, Delete Role. When prompted, choose Yes, Delete.

4. In the Details area, choose Policies.

5. Select APIGatewayAWSProxyExecPolicy, and then choose Policy Actions, Delete. When prompted, choose Delete.