GetChangeTokenCommand

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.

When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WAFRegionalClient, GetChangeTokenCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import
// const { WAFRegionalClient, GetChangeTokenCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import
const client = new WAFRegionalClient(config);
const input = {};
const command = new GetChangeTokenCommand(input);
const response = await client.send(command);
// { // GetChangeTokenResponse
//   ChangeToken: "STRING_VALUE",
// };

Example Usage

 There was an error loading the code editor. Retry

GetChangeTokenCommand Input

See GetChangeTokenCommandInput for more details
GetChangeTokenCommandInput extends GetChangeTokenRequest 

GetChangeTokenCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ChangeToken
string | undefined

The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

Throws

Name
Fault
Details
WAFInternalErrorException
server

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFRegionalServiceException
Base exception class for all service exceptions from WAFRegional service.