@aws-sdk/client-wafv2

Description

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 an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, or 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 applications, 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 applications, 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.

Installing

To install this package, simply type add or install @aws-sdk/client-wafv2 using your favorite package manager:

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

Getting Started

Import

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";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new WAFV2Client({ region: "REGION" });

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

Async/await

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.

Promises

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

Callbacks

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

v2 compatible style

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-wafv2";
const client = new AWS.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.
client.listAPIKeys(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;
   * }
   */
}

Getting Help

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.

• Visit 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-wafv2 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)

AssociateWebACL

Command API Reference / Input / Output

CheckCapacity

Command API Reference / Input / Output

CreateAPIKey

Command API Reference / Input / Output

CreateIPSet

Command API Reference / Input / Output

CreateRegexPatternSet

Command API Reference / Input / Output

CreateRuleGroup

Command API Reference / Input / Output

CreateWebACL

Command API Reference / Input / Output

DeleteAPIKey

Command API Reference / Input / Output

DeleteFirewallManagerRuleGroups

Command API Reference / Input / Output

DeleteIPSet

Command API Reference / Input / Output

DeleteLoggingConfiguration

Command API Reference / Input / Output

DeletePermissionPolicy

Command API Reference / Input / Output

DeleteRegexPatternSet

Command API Reference / Input / Output

DeleteRuleGroup

Command API Reference / Input / Output

DeleteWebACL

Command API Reference / Input / Output

DescribeAllManagedProducts

Command API Reference / Input / Output

DescribeManagedProductsByVendor

Command API Reference / Input / Output

DescribeManagedRuleGroup

Command API Reference / Input / Output

DisassociateWebACL

Command API Reference / Input / Output

GenerateMobileSdkReleaseUrl

Command API Reference / Input / Output

GetDecryptedAPIKey

Command API Reference / Input / Output

GetIPSet

Command API Reference / Input / Output

GetLoggingConfiguration

Command API Reference / Input / Output

GetManagedRuleSet

Command API Reference / Input / Output

GetMobileSdkRelease

Command API Reference / Input / Output

GetPermissionPolicy

Command API Reference / Input / Output

GetRateBasedStatementManagedKeys

Command API Reference / Input / Output

GetRegexPatternSet

Command API Reference / Input / Output

GetRuleGroup

Command API Reference / Input / Output

GetSampledRequests

Command API Reference / Input / Output

GetWebACL

Command API Reference / Input / Output

GetWebACLForResource

Command API Reference / Input / Output

ListAPIKeys

Command API Reference / Input / Output

ListAvailableManagedRuleGroups

Command API Reference / Input / Output

ListAvailableManagedRuleGroupVersions

Command API Reference / Input / Output

ListIPSets

Command API Reference / Input / Output

ListLoggingConfigurations

Command API Reference / Input / Output

ListManagedRuleSets

Command API Reference / Input / Output

ListMobileSdkReleases

Command API Reference / Input / Output

ListRegexPatternSets

Command API Reference / Input / Output

ListResourcesForWebACL

Command API Reference / Input / Output

ListRuleGroups

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListWebACLs

Command API Reference / Input / Output

PutLoggingConfiguration

Command API Reference / Input / Output

PutManagedRuleSetVersions

Command API Reference / Input / Output

PutPermissionPolicy

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateIPSet

Command API Reference / Input / Output

UpdateManagedRuleSetVersionExpiryDate

Command API Reference / Input / Output

UpdateRegexPatternSet

Command API Reference / Input / Output

UpdateRuleGroup

Command API Reference / Input / Output

UpdateWebACL

Command API Reference / Input / Output