GetChangeTokenStatus
Note
AWS WAF Classic support will end on September 30, 2025.
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.
Request Syntax
{
"ChangeToken": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ChangeToken
-
The change token for which you want to get the status. This change token was previously returned in the
GetChangeToken
response.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*
Required: Yes
Response Syntax
{
"ChangeTokenStatus": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ChangeTokenStatus
-
The status of the change token.
Type: String
Valid Values:
PROVISIONED | PENDING | INSYNC
Errors
For information about the errors that are common to all actions, see Common Errors.
- WAFInternalErrorException
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
- WAFNonexistentItemException
-
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: