DeleteIPSet
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.
Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or
if it still includes any IP addresses.
If you just want to remove an IPSet from a Rule, use UpdateRule.
To permanently delete an IPSet from AWS WAF, perform the following steps:
-
Update the
IPSetto remove IP address ranges, if any. For more information, see UpdateIPSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeTokenparameter of aDeleteIPSetrequest. -
Submit a
DeleteIPSetrequest.
Request Syntax
{
"ChangeToken": "string",
"IPSetId": "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
- IPSetId
-
The
IPSetIdof the IPSet that you want to delete.IPSetIdis returned by CreateIPSet and by ListIPSets.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*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 theDeleteIPSetrequest. 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
- WAFNonEmptyEntityException
-
The operation failed because you tried to delete an object that isn't empty. For example:
-
You tried to delete a
WebACLthat still contains one or moreRuleobjects. -
You tried to delete a
Rulethat still contains one or moreByteMatchSetobjects or other predicates. -
You tried to delete a
ByteMatchSetthat contains one or moreByteMatchTupleobjects. -
You tried to delete an
IPSetthat references one or more IP addresses.
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
ByteMatchSetthat is still referenced by aRule. -
You tried to delete a
Rulethat 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:
