UpdateGeoMatchSet
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 GeoMatchConstraint objects in an GeoMatchSet
. For each GeoMatchConstraint
object,
you specify the following values:
-
Whether to insert or delete the object from the array. If you want to change an
GeoMatchConstraint
object, you delete the existing object and add a new one. -
The
Type
. The only valid value forType
isCountry
. -
The
Value
, which is a two character code for the country to add to theGeoMatchConstraint
object. Valid codes are listed in GeoMatchConstraint:Value.
To create and configure an GeoMatchSet
, perform the following steps:
-
Submit a CreateGeoMatchSet request.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of an UpdateGeoMatchSet request. -
Submit an
UpdateGeoMatchSet
request to specify the country that you want AWS WAF to watch for.
When you update an GeoMatchSet
, you specify the country that you want to add and/or the country that you want to delete.
If you want to change a country, you delete the existing country and add the new one.
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
",
"GeoMatchSetId": "string
",
"Updates": [
{
"Action": "string
",
"GeoMatchConstraint": {
"Type": "string
",
"Value": "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
- GeoMatchSetId
-
The
GeoMatchSetId
of the GeoMatchSet that you want to update.GeoMatchSetId
is returned by CreateGeoMatchSet and by ListGeoMatchSets.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*
Required: Yes
- Updates
-
An array of
GeoMatchSetUpdate
objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types:-
GeoMatchSetUpdate: Contains
Action
andGeoMatchConstraint
-
GeoMatchConstraint: Contains
Type
andValue
You can have only one
Type
andValue
perGeoMatchConstraint
. To add multiple countries, include multipleGeoMatchSetUpdate
objects in your request.
Type: Array of GeoMatchSetUpdate 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
ChangeToken
that you used to submit theUpdateGeoMatchSet
request. 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
Rule
from aWebACL
, but theRule
isn'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
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
HTTP Status Code: 400
-
- WAFInvalidParameterException
-
The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
HTTP Status Code: 400
-
- WAFLimitsExceededException
-
The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects 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
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
HTTP Status Code: 400
-
- WAFNonexistentItemException
-
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
- WAFReferencedItemException
-
The operation failed because you tried to delete an object that is still in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
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: