@aws-sdk/client-waf

Description

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

This is AWS WAF Classic documentation. For
more information, see AWS
WAF Classic in the developer guide.

For the latest version of AWS
WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

This is the AWS WAF Classic API Reference for using AWS WAF Classic with Amazon CloudFront. The AWS WAF Classic actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF Classic API actions,
data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the
AWS WAF Classic in the developer guide.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { WAFClient, ListIPSetsCommand } = require("@aws-sdk/client-waf");
`

`ts
// ES6+ example
import { WAFClient, ListIPSetsCommand } from "@aws-sdk/client-waf";
`

$3

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.

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

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

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// 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.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
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.

`js
// 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

`ts
import * as AWS from "@aws-sdk/client-waf";
const client = new AWS.WAF({ region: "REGION" });

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

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

// callbacks.
client.listIPSets(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
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-waf` 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)

CreateByteMatchSet

Command API Reference / Input / Output

CreateGeoMatchSet

Command API Reference / Input / Output

CreateIPSet

Command API Reference / Input / Output

CreateRateBasedRule

Command API Reference / Input / Output

CreateRegexMatchSet

Command API Reference / Input / Output

CreateRegexPatternSet

Command API Reference / Input / Output

CreateRule

Command API Reference / Input / Output

CreateRuleGroup

Command API Reference / Input / Output

CreateSizeConstraintSet

Command API Reference / Input / Output

CreateSqlInjectionMatchSet

Command API Reference / Input / Output

CreateWebACL

Command API Reference / Input / Output

CreateWebACLMigrationStack

Command API Reference / Input / Output

CreateXssMatchSet

Command API Reference / Input / Output

DeleteByteMatchSet

Command API Reference / Input / Output

DeleteGeoMatchSet

Command API Reference / Input / Output

DeleteIPSet

Command API Reference / Input / Output

DeleteLoggingConfiguration

Command API Reference / Input / Output

DeletePermissionPolicy

Command API Reference / Input / Output

DeleteRateBasedRule

Command API Reference / Input / Output

DeleteRegexMatchSet

Command API Reference / Input / Output

DeleteRegexPatternSet

Command API Reference / Input / Output

DeleteRule

Command API Reference / Input / Output

DeleteRuleGroup

Command API Reference / Input / Output

DeleteSizeConstraintSet

Command API Reference / Input / Output

DeleteSqlInjectionMatchSet

Command API Reference / Input / Output

DeleteWebACL

Command API Reference / Input / Output

DeleteXssMatchSet

Command API Reference / Input / Output

GetByteMatchSet

Command API Reference / Input / Output

GetChangeToken

Command API Reference / Input / Output

GetChangeTokenStatus

Command API Reference / Input / Output

GetGeoMatchSet

Command API Reference / Input / Output

GetIPSet

Command API Reference / Input / Output

GetLoggingConfiguration

Command API Reference / Input / Output

GetPermissionPolicy

Command API Reference / Input / Output

GetRateBasedRule

Command API Reference / Input / Output

GetRateBasedRuleManagedKeys

Command API Reference / Input / Output

GetRegexMatchSet

Command API Reference / Input / Output

GetRegexPatternSet

Command API Reference / Input / Output

GetRule

Command API Reference / Input / Output

GetRuleGroup

Command API Reference / Input / Output

GetSampledRequests

Command API Reference / Input / Output

GetSizeConstraintSet

Command API Reference / Input / Output

GetSqlInjectionMatchSet

Command API Reference / Input / Output

GetWebACL

Command API Reference / Input / Output

GetXssMatchSet

Command API Reference / Input / Output

ListActivatedRulesInRuleGroup

Command API Reference / Input / Output

ListByteMatchSets

Command API Reference / Input / Output

ListGeoMatchSets

Command API Reference / Input / Output

ListIPSets

Command API Reference / Input / Output

ListLoggingConfigurations

Command API Reference / Input / Output

ListRateBasedRules

Command API Reference / Input / Output

ListRegexMatchSets

Command API Reference / Input / Output

ListRegexPatternSets

Command API Reference / Input / Output

ListRuleGroups

Command API Reference / Input / Output

ListRules

Command API Reference / Input / Output

ListSizeConstraintSets

Command API Reference / Input / Output

ListSqlInjectionMatchSets

Command API Reference / Input / Output

ListSubscribedRuleGroups

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListWebACLs

Command API Reference / Input / Output

ListXssMatchSets

Command API Reference / Input / Output

PutLoggingConfiguration

Command API Reference / Input / Output

PutPermissionPolicy

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateByteMatchSet

Command API Reference / Input / Output

UpdateGeoMatchSet

Command API Reference / Input / Output

UpdateIPSet

Command API Reference / Input / Output

UpdateRateBasedRule

Command API Reference / Input / Output

UpdateRegexMatchSet

Command API Reference / Input / Output

UpdateRegexPatternSet

Command API Reference / Input / Output

UpdateRule

Command API Reference / Input / Output

UpdateRuleGroup

Command API Reference / Input / Output

UpdateSizeConstraintSet

Command API Reference / Input / Output

UpdateSqlInjectionMatchSet

Command API Reference / Input / Output

UpdateWebACL

Command API Reference / Input / Output

UpdateXssMatchSet

Command API Reference / Input / Output