@aws-sdk/client-waf-regional
Description
AWS SDK for JavaScript WAFRegional Client for Node.js, Browser and React Native.
This is AWS WAF Classic Regional 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 Regional Classic API Reference for using AWS WAF Classic with the AWS resources, Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. The AWS WAF Classic actions and data types listed in the reference are available for protecting Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. You can use these actions and data types by means of the endpoints listed in AWS Regions and Endpoints. 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 the this package, simply type add or install @aws-sdk/client-waf-regional
using your favorite package manager:
npm install @aws-sdk/client-waf-regional
yarn add @aws-sdk/client-waf-regional
pnpm add @aws-sdk/client-waf-regional
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the WAFRegionalClient
and
the commands you need, for example AssociateWebACLCommand
:
const { WAFRegionalClient, AssociateWebACLCommand } = require("@aws-sdk/client-waf-regional");
import { WAFRegionalClient, AssociateWebACLCommand } from "@aws-sdk/client-waf-regional";
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.
const client = new WAFRegionalClient({ region: "REGION" });
const params = {
};
const command = new AssociateWebACLCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} 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) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, 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-waf-regional";
const client = new AWS.WAFRegional({ region: "REGION" });
try {
const data = await client.associateWebACL(params);
} catch (error) {
}
client
.associateWebACL(params)
.then((data) => {
})
.catch((error) => {
});
client.associateWebACL(params, (err, 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);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
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.
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-regional
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.