@aws-sdk/client-apigatewayv2
Advanced tools
AWS SDK for JavaScript Apigatewayv2 Client for Node.js, Browser and React Native
@aws-sdk/client-apigatewayv2 is a part of the AWS SDK for JavaScript, which allows developers to interact with the Amazon API Gateway V2 service. This package provides a set of APIs to create, configure, and manage API Gateway resources, including HTTP APIs, WebSocket APIs, and their integrations, routes, and stages.
Create an HTTP API
This feature allows you to create a new HTTP API. The code sample demonstrates how to use the CreateApiCommand to create an HTTP API named 'MyHttpApi' in the 'us-west-2' region.
const { ApiGatewayV2Client, CreateApiCommand } = require('@aws-sdk/client-apigatewayv2');
const client = new ApiGatewayV2Client({ region: 'us-west-2' });
const params = {
Name: 'MyHttpApi',
ProtocolType: 'HTTP'
};
const run = async () => {
try {
const data = await client.send(new CreateApiCommand(params));
console.log('API Created', data);
} catch (err) {
console.error(err);
}
};
run();Create a WebSocket API
This feature allows you to create a new WebSocket API. The code sample demonstrates how to use the CreateApiCommand to create a WebSocket API named 'MyWebSocketApi' with a route selection expression in the 'us-west-2' region.
const { ApiGatewayV2Client, CreateApiCommand } = require('@aws-sdk/client-apigatewayv2');
const client = new ApiGatewayV2Client({ region: 'us-west-2' });
const params = {
Name: 'MyWebSocketApi',
ProtocolType: 'WEBSOCKET',
RouteSelectionExpression: '$request.body.action'
};
const run = async () => {
try {
const data = await client.send(new CreateApiCommand(params));
console.log('WebSocket API Created', data);
} catch (err) {
console.error(err);
}
};
run();Create an Integration
This feature allows you to create an integration for an API. The code sample demonstrates how to use the CreateIntegrationCommand to create an AWS_PROXY integration with a Lambda function for a specified API.
const { ApiGatewayV2Client, CreateIntegrationCommand } = require('@aws-sdk/client-apigatewayv2');
const client = new ApiGatewayV2Client({ region: 'us-west-2' });
const params = {
ApiId: 'api-id',
IntegrationType: 'AWS_PROXY',
IntegrationUri: 'arn:aws:lambda:us-west-2:123456789012:function:my-function',
PayloadFormatVersion: '2.0'
};
const run = async () => {
try {
const data = await client.send(new CreateIntegrationCommand(params));
console.log('Integration Created', data);
} catch (err) {
console.error(err);
}
};
run();Create a Route
This feature allows you to create a route for an API. The code sample demonstrates how to use the CreateRouteCommand to create a route with a specified route key and target integration for a given API.
const { ApiGatewayV2Client, CreateRouteCommand } = require('@aws-sdk/client-apigatewayv2');
const client = new ApiGatewayV2Client({ region: 'us-west-2' });
const params = {
ApiId: 'api-id',
RouteKey: 'GET /myroute',
Target: 'integrations/integration-id'
};
const run = async () => {
try {
const data = await client.send(new CreateRouteCommand(params));
console.log('Route Created', data);
} catch (err) {
console.error(err);
}
};
run();Deploy an API
This feature allows you to deploy an API to a specified stage. The code sample demonstrates how to use the CreateDeploymentCommand to deploy an API to the 'dev' stage.
const { ApiGatewayV2Client, CreateDeploymentCommand } = require('@aws-sdk/client-apigatewayv2');
const client = new ApiGatewayV2Client({ region: 'us-west-2' });
const params = {
ApiId: 'api-id',
StageName: 'dev'
};
const run = async () => {
try {
const data = await client.send(new CreateDeploymentCommand(params));
console.log('API Deployed', data);
} catch (err) {
console.error(err);
}
};
run();The Serverless Framework is a popular open-source framework for building and deploying serverless applications. It supports multiple cloud providers, including AWS, and provides a higher-level abstraction for managing API Gateway resources. Compared to @aws-sdk/client-apigatewayv2, Serverless Framework offers more features for deployment automation and infrastructure as code.
The AWS Cloud Development Kit (CDK) is an open-source software development framework for defining cloud infrastructure in code and provisioning it through AWS CloudFormation. It provides a higher-level abstraction for managing AWS resources, including API Gateway. Compared to @aws-sdk/client-apigatewayv2, AWS CDK offers a more comprehensive and integrated approach to infrastructure management and deployment.
Claudia.js is a tool for deploying Node.js projects to AWS Lambda and API Gateway. It simplifies the process of creating and managing serverless APIs by automating the deployment and configuration steps. Compared to @aws-sdk/client-apigatewayv2, Claudia.js focuses on ease of use and rapid deployment for Node.js applications.
AWS SDK for JavaScript ApiGatewayV2 Client for Node.js, Browser and React Native.
Amazon API Gateway V2
To install this package, simply type add or install @aws-sdk/client-apigatewayv2 using your favorite package manager:
npm install @aws-sdk/client-apigatewayv2yarn add @aws-sdk/client-apigatewayv2pnpm add @aws-sdk/client-apigatewayv2The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ApiGatewayV2Client and
the commands you need, for example GetApisCommand:
// ES5 example
const { ApiGatewayV2Client, GetApisCommand } = require("@aws-sdk/client-apigatewayv2");
// ES6+ example
import { ApiGatewayV2Client, GetApisCommand } from "@aws-sdk/client-apigatewayv2";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new ApiGatewayV2Client({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new GetApisCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-apigatewayv2";
const client = new AWS.ApiGatewayV2({ region: "REGION" });
// async/await.
try {
const data = await client.getApis(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.getApis(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.getApis(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-apigatewayv2 package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.758.0 (2025-02-27)
FAQs
AWS SDK for JavaScript Apigatewayv2 Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-apigatewayv2 receives a total of 207,638 weekly downloads. As such, @aws-sdk/client-apigatewayv2 popularity was classified as popular.
We found that @aws-sdk/client-apigatewayv2 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
TypeScript is porting its compiler to Go, delivering 10x faster builds, lower memory usage, and improved editor performance for a smoother developer experience.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.