While API Gateway makes it extremely simple to build routes and methods, there is one area that always seems to slow me down, and that is Integration Request > Mapping Templates. I find that i'm not building these templates frequently enough to memorize the variables, but frequently enough that I find my time being bottle-necked here. This will be my attempt to build a cheat sheet of my most commonly used mapping variables to hopefully speed up this process.
A common scenario is sending a request to Lambda, which is then making some sort of action on DynamoDB and returning the result. One of the quirks of DynamoDB is that the datatype of the content you are sending to the database is defined with it's own special syntax, and not contextually, using attribute values.
However the point of this is just to explain, that in many of the examples below we will be submitting all of our values as strings, even if it is a number or boolean, and the datatype would then later be defined in the Lambda function using attribute values. Whether you submit your data as a string or not will depend on the Lambda function on the other end. Let us assume for consistency in this article, that we will be defining all data types in our Lambda function, unless otherwise explicitly stated.
One of the most common scenarios in API Gateway is authorizing an incoming request inside of Method Request, to check a Cognito ID Token against one of our user pools. Then after the request is authorized we need to extract that user id (sub) because we will be using it as a sort key (primary or secondary) in a DynamoDB table. In this way we can ensure that a user can only pull their own data from a table.
Often times we will want to pull the value from a variable query parameter, which is common in a REST API. For example say we have the following route:
https://widget.com/products/{product_id}
Where product_id is a variable that is being dynamically inserted by our application. So in this case we need to pull this value out of the query string.
And then to extract that inside of a Lambda function you would use the following reference:
event.queryStringParameters.product_id
There is a way to simplify the reference in the mapping template however, so that we use API gateway to extract the variable from the path.
If you go into Method Execution > URL Query String Parameters there is a GUI for adding the parameters you want to extract. Which would then allow you to simplify Integration Request > Mapping Template
That process works, but it has some drawbacks. For example if any of those items are missing, or they come in as an unexpected data type (like a number instead of a string) we will throw an error.
What can be even more useful and flexible is something like this
Mapping_Template
{ "body": $input.json('$') }
Which will then pass the whole request body through to Lambda, and we can deal with any missing keys or type enforcement there. For example by just using that simple template I can do exactly the same thing but I just get an event in Lambda that looks like this:
Free desktop AI Chat client, designed for developers and businesses. Unlocks advanced model settings only available in the API. Includes quality of life features like custom syntax highlighting.
React is a declarative, efficient, and flexible JavaScript library for building user interfaces. It lets you compose complex UIs from small and isolated pieces of code called “components”.
Bidbear is a report automation tool. It downloads Amazon Seller and Advertising reports, daily, to a private database. It then merges and formats the data into beautiful, on demand, exportable performance reports.
JavaScript is a lightweight, interpreted programming language with first-class functions that is known for its role in web development. It is an essential part of web applications and allows for interactive elements.
Docker is a platform for developers and sysadmins to develop, deploy, and run applications with containers. The use of Linux containers to deploy applications is called containerization.
React is a declarative, efficient, and flexible JavaScript library for building user interfaces. It lets you compose complex UIs from small and isolated pieces of code called “components”.
Redux is a predictable state container for JavaScript apps. It helps you write applications that behave consistently, run in different environments (client, server, and native), and are easy to test.
Vite is a modern, fast front-end build tool that significantly improves the frontend development experience. It features a dev server with Hot Module Replacement (HMR) and a build command that bundles your code with Rollup, which is configured to output highly optimized static assets for production.
Next.js is an open-source React front-end development web framework that enables functionality such as server-side rendering and generating static websites for React based web applications.
Docusaurus is a project for building, deploying, and maintaining open source project websites easily. It's optimized for documentation and can leverage the power of Markdown and React to enable seamless documentation sites with built-in search capabilities.
Stripe is a technology company that builds economic infrastructure for the internet. Businesses of every size use the company's software to accept payments and manage their businesses online.
Sentry is an open-source error tracking tool that helps developers monitor and fix crashes in real time. The tool streamlines the error resolution process and aggregates errors across different programming languages.
D3.js is a JavaScript library for producing dynamic, interactive data visualizations in web browsers. It uses HTML, SVG, and CSS to bring data to life through a data-driven approach to DOM manipulation.
React Flow is a highly customizable library for building interactive node-based editors, diagrams, and flow charts. It provides a set of tools that make it easy to drag, drop, and connect nodes on a canvas.
TipTap is a headless, framework-agnostic text editor capable of handling a variety of complex text editing needs. It is built on top of ProseMirror and is extendable and customizable to fit different editing requirements.
JavaScript is a lightweight, interpreted programming language with first-class functions that is known for its role in web development. It is an essential part of web applications and allows for interactive elements.
Python is a high-level, interpreted, general-purpose programming language. Its design philosophy emphasizes code readability with its use of significant whitespace.
Amazon Cognito provides authentication, authorization, and user management for your web and mobile apps. Users can sign in directly with a username and password, or through a third party such as Facebook, Amazon, or Google.
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. It acts as a front door for applications to access data, business logic, or functionality from your back-end services.
AWS Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda executes your code only when needed and scales automatically, from a few requests per day to thousands per second.
Amazon Athena is an interactive query service that makes it easy to analyze data in Amazon S3 using standard SQL. It is serverless, so there is no infrastructure to manage, and you pay only for the queries that you run.
AWS Glue is a fully managed extract, transform, and load (ETL) service that makes it simple and cost-effective to categorize your data, clean it, enrich it, and move it reliably between various data stores.
AWS Step Functions is a service that lets you coordinate multiple AWS services into serverless workflows so you can build and update apps quickly. It provides a reliable way to orchestrate the components of distributed applications and microservices using visual workflows.
Amazon Simple Queue Service (SQS) is a fully managed message queuing service that enables you to decouple and scale microservices, distributed systems, and serverless applications. SQS eliminates the complexity and overhead associated with managing and operating message oriented middleware.
Amazon DynamoDB is a fast and flexible NoSQL database service for all applications that need consistent, single-digit millisecond latency at any scale. It is a fully managed database and supports both document and key-value store models.
Amazon S3 (Simple Storage Service) is an object storage service that offers industry-leading scalability, data availability, security, and performance. This means customers of all sizes and industries can use it to store and protect any amount of data for a range of use cases, such as websites, mobile applications, backup and restore, archive, enterprise applications, IoT devices, and big data analytics.
Amazon CloudWatch is a monitoring and observability service built for DevOps engineers, developers, site reliability engineers (SREs), and IT managers. CloudWatch provides data and actionable insights to monitor applications, understand and respond to system-wide performance changes, optimize resource utilization, and get a unified view of operational health.
Amazon CloudFront is a fast content delivery network (CDN) service that securely delivers data, videos, applications, and APIs to customers globally with low latency, high transfer speeds, all within a developer-friendly environment.
Amazon Route 53 is a highly available and scalable cloud Domain Name System (DNS) web service. It is designed to give developers and businesses an extremely reliable and cost-effective way to route end users to Internet applications.
Amazon EventBridge is a serverless event bus service that makes it easy to connect applications together using data from your own applications, integrated SaaS applications, and AWS services. EventBridge helps facilitate event-driven architectures by routing events between AWS services, integrated SaaS applications, and your own applications.