WAF / Client / get_change_token_status
get_change_token_status#
- WAF.Client.get_change_token_status(**kwargs)#
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.
Returns the status of a
ChangeToken
that you got by calling GetChangeToken.ChangeTokenStatus
is one of the following values:PROVISIONED
: You requested the change token by callingGetChangeToken
, but you haven’t used it yet in a call to create, update, or delete an AWS WAF object.PENDING
: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.INSYNC
: Propagation is complete.
See also: AWS API Documentation
Request Syntax
response = client.get_change_token_status( ChangeToken='string' )
- Parameters:
ChangeToken (string) –
[REQUIRED]
The change token for which you want to get the status. This change token was previously returned in the
GetChangeToken
response.- Return type:
dict
- Returns:
Response Syntax
{ 'ChangeTokenStatus': 'PROVISIONED'|'PENDING'|'INSYNC' }
Response Structure
(dict) –
ChangeTokenStatus (string) –
The status of the change token.
Exceptions
WAF.Client.exceptions.WAFNonexistentItemException
WAF.Client.exceptions.WAFInternalErrorException
Examples
The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.
response = client.get_change_token_status( ChangeToken='abcd12f2-46da-4fdb-b8d5-fbd4c466928f', ) print(response)
Expected Output:
{ 'ChangeTokenStatus': 'PENDING', 'ResponseMetadata': { '...': '...', }, }