> ## Documentation Index
> Fetch the complete documentation index at: https://cloud-architect.ipoint-labs.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Build API Gateway with path parameter and Query string parameter
> Hands-on lab · 45m
Launch this lab in the IP Lab Portal, then follow the steps below in the AWS console.
Open IP Lab Portal
## Overview
### Lab Details
1. This lab walks you through the steps to create an API Gateway with path and query string parameters and integrate it into the Lambda function.
2. You will practice using Amazon API Gateway.
3. Duration of the Lab: **45 minutes.**
4. AWS Region: **US East (N. Virginia) us-east-1**.
### Introduction
#### Amazon API Gateway
* Amazon API Gateway is a **fully managed service** that makes it easy for developers to create, publish, maintain, monitor, and secure APIs at any scale.
* APIs act as the **front door** for applications to access data, business logic, or functionality from your backend services.
* API Gateway handles all the tasks involved in accepting and processing up to hundreds of thousands of concurrent API calls, including traffic management, CORS support, authorization and access control, throttling, monitoring, and API version management.
* Using API Gateway, you can create RESTful APIs and WebSocket APIs that enable real-time two-way communication applications. API Gateway supports containerized and serverless workloads, as well as web applications.
* AWS Lambda lets you run code without provisioning or managing servers. You pay only for the compute time you consume.
* With Lambda, you can run code for virtually any type of application or backend service - all with zero administration. Just upload your code and Lambda takes care of everything required to run and scale your code with high availability. You can set up your code to automatically trigger from other AWS services or call it directly from any web or mobile app.
### Architecture Diagram
### Task Details
1. Sign in to the AWS Management Console.
2. Create a Lambda Function.
3. Create a new API Gateway.
4. Create a Resource with a path parameter.
5. Create a Method.
6. Add a query string parameter.
7. Test the API
### Launching Lab Environment
1. To launch the lab environment, Click on the **Start Lab** button.
2. Please wait until the cloud environment is provisioned. It will take less than a minute to provision.
3. Once the lab is started, you will be provided with an **IAM username**, **Password**, **Access** **Key**, and **Secret** **Access** **Key**.
> **Note**: You can only start one lab at any given time
## Lab guide
### Lab Steps
#### Task 1: Sign in to the AWS Management Console
1. Click on the **Open Console** button, and you will get redirected to AWS Console in a new browser tab.
2. On the AWS sign-in page,
* Leave the Account ID as default. Never edit/remove the 12-digit Account ID present in the AWS Console. otherwise, you cannot proceed with the lab.
* Now copy your **User Name** and **Password** in the Lab Console to the **IAM Username and Password** in the AWS Console and click on the **Sign in** button.
3. Once Signed In to the AWS Management Console, Make the default AWS Region as **US East (N. Virginia) us-east-1.**
#### Task 2: Create a Lambda Function
In this task, we will create a Lambda function by providing the required configurations like name, runtime, roles, etc.
1. Navigate to the **Services** menu at the top, then click on **Lambda** under the **Compute** section.
2. Click on the **Create function** button.
* Select **Author from Scratch**
* Function Name: Enter ***WhizlabsAPI***
* Runtime: Select **Python 3.9**
* Under **Change default execution role**
* Choose **Use an existing role.**
* Role Name: Enter ***Whiz\_lambda\_role-\***
* Leave other options as default.
* Click on the **Create function** button.
3. Once the Lambda Function is created successfully, it will look like the screenshot below:
4. Under **Function code**:
* Replace the existing code with the below Python code.
```python theme={null}
import json
def lambda_handler(event, context):
# Path parameter passed to Lambda function
servername = event["params"]["path"]["servername"]
# Query string parameter passed to Lambda function
email_id = event["params"]["querystring"]["emailid"]
return {
"Path Parameter": servername,
"Query string Parameter": email_id
}
```
5. Click the **Deploy** button.
#### Task 3: Create an API Gateway
1. Navigate to the **Services** menu at the top, then click on **API Gateway** in the **Network and Content Delivery** section.
2. Click on the **Build** button in REST API.
3. Select Protocol as **REST**
4. Create a new API: Choose a **New API.**
5. Under **settings**:
* API name : Enter ***WhizlabAPI***
* Leave other options as default\*\*.\*\*
* Click on the **Create API** button.
#### Task 4: Creating a Resource with a path parameter
1. Once the API is created, click on **Create Resource**
* Resource Name: Enter ***\{servername}***
* **Note**: The resource name should be placed inside flower brackets **\{ }**
* Leave everything as default.
3. Now click on the **Create Resource** button.
#### Task 5: Creating a Method
1. Once you create a resource, click on **Create Method** button.
2. From the drop-down, select **GET.**
3. **Setup**:
* Integration Type: Select **Lambda Function**
* Lambda Region: select **us-east-1**
* Lambda function: Enter ***WhizlabsAPI*** and select the function name you created from the list.
* Leave everything else as default.
4. Click on the **Create Method** button.
* **Note:** If any pop-ups appear, click on the **OK** button.
5. Once the method has been created, your screen will look similar to the screenshot below:
#### Task 6: Add a query string parameter
1. Click on the **Method Request** link in the **GET** method page.
2. Under **Method request Settings** :
* Click on the **Edit** button.
* Request Validator: Select **Validate body, query string parameters, and headers**
3. Under **URL Query String Parameters**:
* Click on the **Add query string** button.
* Name: Enter ***emailid***
* Check the checkbox below **Required.**
4. Click on **Save**.
5. Click on the **Integration Request** link in the GET method page.
6. Click on **Edit** and Scroll down to the bottom and select **Mapping Templates.**
7. **Request Body passthrough**: Select **When there are no templates defined(recommended)**
8. Click on **Add mapping template.**
9. Content type: Enter ***application/json***
10. Again, scroll down to the page to the bottom.
11. Generate template: Select **Method Request passthrough** from the list.
12. Click on the **Save** button.
**Note:** Clicking on the save button won't redirect you to any page, but make sure you click the save button.
#### Task 7: Deploy the API Gateway
1. Once the resource and the method have been created successfully, you can deploy the API.
2. Now again, select the **GET** from the hierarchy.
3. Click on the **Deploy API**.
4. Select the Deployment Stage in the drop-down as **New Stage**.
5. Enter Stage Name: ***TestingAPI*** and Stage description as ***Testing environment for my WhizlabsAPI***.
6. Click on the **Deploy** button.
6. Once the API has been deployed, navigate to **Stages** and click on the stage name. You will be able to see the following:
7. Now click on the **GET** method.
8. Copy and Paste the **Invoke URL** in a new tab of your browser.
9. Now replace **\{servername}** with ***Production*** and then add **?emailid=[whizlabs.user1@gmail.com](mailto:whizlabs.user1@gmail.com)**
10. You will receive the GET request's response from the API. Here's an example:
> ##### Do you know ?
>
> Path parameters can expose sensitive information if not handled properly. For example, if you include confidential information directly in the URL path, it might end up in server logs or browser history. It's important to handle such data carefully and consider alternatives like request bodies or headers for sensitive information.
1. Once the lab steps are completed, please click the **Validation** button on the right side panel.
2. This will validate the resources in the AWS account and show you whether you have completed this lab successfully or not.
### Completion and Conclusion
1. You have successfully created a Lambda function.
2. You have successfully created the API.
3. You have successfully created the API Resource and Method.
4. You have successfully created path and query string parameters.
5. You have successfully tested the API.
### End Lab
1. Sign out of AWS Account.
2. You have successfully completed the lab.
3. Once you have completed the steps, click on **End Lab** from the IP Lab Portal dashboard.
## What gets checked
When you press **Check my work**, the platform verifies each of these:
* **Create an AWS Lambda Function** — Check whether a Lambda Function is created or not
* **Create a API Gateway** — Check whether a REST/HTTP?WEBSOCKET API gateway is created or not
## Related help
* [FAQs and Troubleshooting](/aws-saa/support/faqs-and-troubleshooting)
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.