@aws-sdk/client-waf-browser

Description

This is the AWS WAF API Reference for using AWS WAF with Amazon CloudFront. The AWS WAF 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 API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-waf-browser

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(WAFClient) and the commands you need, for example CreateByteMatchSetCommand:

//JavaScript
const { WAFClient } = require("@aws-sdk/client-waf-browser/WAFClient");
const {
  CreateByteMatchSetCommand
} = require("@aws-sdk/client-waf-browser/commands/CreateByteMatchSetCommand");

//TypeScript
import { WAFClient } from "@aws-sdk/client-waf-browser/WAFClient";
import { CreateByteMatchSetCommand } from "@aws-sdk/client-waf-browser/commands/CreateByteMatchSetCommand";

Usage

To send a request, you:

Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
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 wAF = new WAFClient({region: 'region'});
//clients can be shared by different commands
const params = {
  Name: /**a string value*/,
  ChangeToken: /**a string value*/,
};
const createByteMatchSetCommand = new CreateByteMatchSetCommand(params);
wAF.send(createByteMatchSetCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await wAF.send(createByteMatchSetCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
wAF.send(createByteMatchSetCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-waf-browser/WAF";
const wAF = new AWS.WAF({ region: "region" });
wAF.createByteMatchSet(params, (err, data) => {
  //do something
});

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 wAF.send(createByteMatchSetCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

Ask a question on StackOverflow and tag it with aws-sdk-js
Come join the AWS JavaScript community on gitter
If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-waf-browser' package is updated. To contribute to SDK you can checkout our code generator package.

License

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