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

WAF

This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.

If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created before. WAF Classic support will end on September 30, 2025.

For information about WAF, including how to migrate your WAF Classic resources to this version, see the WAF Developer Guide.

WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to a protected resource. Protected resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, and Amazon Web Services Verified Access instance. WAF also lets you control access to your content, to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code (Forbidden), or with a custom response.

This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and guidance for configuring and using WAF, see the WAF Developer Guide.

You can make calls using the endpoints listed in WAF endpoints and quotas.

• For regional resources, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

• For Amazon CloudFront and Amplify, you must use the API endpoint listed for US East (N. Virginia): us-east-1.

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

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

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

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

// ES5 example
const { WAFV2Client, ListAPIKeysCommand } = require("@aws-sdk/client-wafv2");

// ES6+ example
import { WAFV2Client, ListAPIKeysCommand } from "@aws-sdk/client-wafv2";

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 WAFV2Client({ region: "REGION" });

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

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.
}

You can also use Promise chaining.

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

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

WAFV2 extends WAFV2Client 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 (WAFV2Client). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { WAFV2 } from "@aws-sdk/client-wafv2";

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

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

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

// callbacks (not recommended).
client.listAPIKeys(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;
   * }
   */
}

See also docs/ERROR_HANDLING.

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.

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-wafv2 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.