get_change_token

get_change_token()

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.get_change_token()

Return type

dict

Returns

Response Syntax

{
    'ChangeToken': 'string'
}

Response Structure

• (dict) --
  • ChangeToken (string) --

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

Exceptions

• WAF.Client.exceptions.WAFInternalErrorException

Examples

The following example returns a change token to use for a create, update or delete operation.

response = client.get_change_token(
)

print(response)

Expected Output:

{
    'ChangeToken': 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'ResponseMetadata': {
        '...': '...',
    },
}