@aws-sdk/client-lambda-web

Description

AWS SDK for JavaScript LambdaWeb Client for Node.js, Browser and React Native.

AWS Lambda Web Functions is a capability of AWS Lambda that you can use to run web applications and API backends as serverless HTTP servers. Your code listens on a network port and handles requests directly. You can use familiar Node.js web frameworks such as Express, Hono, or React Router with no Lambda-specific adapters or wrappers. You develop and run your server locally like any other Node.js web app.

Lambda creates an HTTPS endpoint, manages the execution environments, and scales your application with traffic, including to zero when it's idle. To reduce latency for globally distributed users, you can deploy across multiple AWS Regions behind a single endpoint.

A Web Function has one or more immutable revisions (code and configuration) and one or more endpoints that expose it over HTTPS.

Use Web Functions for workloads that receive and respond to HTTP traffic directly. Common use cases include:

• Web applications – Deploy full-stack or front-end applications that serve HTML, assets, and API routes from a single deployment.

• REST and GraphQL APIs – Build API backends that serve high request volumes.

• Microservices – Run HTTP services that scale independently with traffic, including to zero when idle.

• Server-side rendering (SSR) – Serve pages that are rendered on the server at request time rather than pre-built. A Web Function runs your framework's production server directly. This suits applications that render personalized or frequently changing content on each request.

• Streaming responses – Stream output to the client as it is produced, such as responses from a large language model.

For event-driven processing, such as handling queue messages or file uploads, use Lambda Event Functions instead. For more information about Web Functions, see Lambda Web Functions in the AWS Lambda Developer Guide.

Installing

To install this package, use the CLI of your favorite package manager:

• npm install @aws-sdk/client-lambda-web
• yarn add @aws-sdk/client-lambda-web
• pnpm add @aws-sdk/client-lambda-web

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the LambdaWebClient and the commands you need, for example ListTagsCommand:

// ES5 example
const { LambdaWebClient, ListTagsCommand } = require("@aws-sdk/client-lambda-web");

// ES6+ example
import { LambdaWebClient, ListTagsCommand } from "@aws-sdk/client-lambda-web";

Usage

To send a request:

• Instantiate a client with configuration (e.g. credentials, region).
  • See docs/CLIENTS for configuration details.
  • See @aws-sdk/config for additional options.
• Instantiate a command with input parameters.
• Call the send operation on the client, providing the command object as input.

const client = new LambdaWebClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListTagsCommand(params);

Async/await

We recommend using the 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.
}

Promises

You can also use Promise chaining.

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

LambdaWeb extends LambdaWebClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (LambdaWebClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { LambdaWeb } from "@aws-sdk/client-lambda-web";

const client = new LambdaWeb({ region: "REGION" });

// async/await.
try {
  const data = await client.listTags(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listTags(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listTags(params, (err, data) => {
  // process err and data.
});

Troubleshooting

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;
   * }
   */
}

See also docs/ERROR_HANDLING.

Getting Help

Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit the Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-lambda-web package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)