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.
Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object,
you specify the following values:
-
Whether to insert or delete the
RegexPatternString. -
The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.
For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to:
-
BadBot
-
BadB0t
-
B@dBot
-
B@dB0t
To create and configure a RegexPatternSet, perform the following steps:
-
Create a
RegexPatternSet.For more information, see CreateRegexPatternSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeTokenparameter of anUpdateRegexPatternSetrequest. -
Submit an
UpdateRegexPatternSetrequest to specify the regular expression pattern that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
Request Syntax
{
"ChangeToken": "string",
"RegexPatternSetId": "string",
"Updates": [
{
"Action": "string",
"RegexPatternString": "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 value returned by the most recent call to GetChangeToken.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: Yes
- RegexPatternSetId
-
The
RegexPatternSetIdof the RegexPatternSet that you want to update.RegexPatternSetIdis returned by CreateRegexPatternSet and by ListRegexPatternSets.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: Yes
- Updates
-
An array of
RegexPatternSetUpdateobjects that you want to insert into or delete from a RegexPatternSet.Type: Array of RegexPatternSetUpdate objects
Array Members: Minimum number of 1 item.
Required: Yes
Response Syntax
{
"ChangeToken": "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.
- ChangeToken
-
The
ChangeTokenthat you used to submit theUpdateRegexPatternSetrequest. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*
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
- WAFInvalidAccountException
-
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
- WAFInvalidOperationException
-
The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rulefrom aWebACL, but theRuleisn't in the specifiedWebACL. -
You tried to remove an IP address from an
IPSet, but the IP address isn't in the specifiedIPSet. -
You tried to remove a
ByteMatchTuplefrom aByteMatchSet, but theByteMatchTupleisn't in the specifiedWebACL. -
You tried to add a
Ruleto aWebACL, but theRulealready exists in the specifiedWebACL. -
You tried to add a
ByteMatchTupleto aByteMatchSet, but theByteMatchTuplealready exists in the specifiedWebACL.
HTTP Status Code: 400
-
- WAFInvalidRegexPatternException
-
The regular expression (regex) you specified in
RegexPatternStringis invalid.HTTP Status Code: 400
- WAFLimitsExceededException
-
The operation exceeds a resource limit, for example, the maximum number of
WebACLobjects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide.HTTP Status Code: 400
- WAFNonexistentContainerException
-
The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:
-
You tried to add a
Ruleto or delete aRulefrom aWebACLthat doesn't exist. -
You tried to add a
ByteMatchSetto or delete aByteMatchSetfrom aRulethat doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSetthat doesn't exist. -
You tried to add a
ByteMatchTupleto or delete aByteMatchTuplefrom aByteMatchSetthat doesn't exist.
HTTP Status Code: 400
-
- WAFNonexistentItemException
-
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
- WAFStaleDataException
-
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
