Skip to main content

Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

DeleteIPSetCommand

Suggest an Edit

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 IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.
Submit a DeleteIPSet request.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WAFClient, DeleteIPSetCommand } from "@aws-sdk/client-waf"; // ES Modules import
// const { WAFClient, DeleteIPSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import
const client = new WAFClient(config);
const input = { // DeleteIPSetRequest
  IPSetId: "STRING_VALUE", // required
  ChangeToken: "STRING_VALUE", // required
};
const command = new DeleteIPSetCommand(input);
const response = await client.send(command);
// { // DeleteIPSetResponse
//   ChangeToken: "STRING_VALUE",
// };

Example Usage

Loading code editorLoading code editor

DeleteIPSetCommand Input

See DeleteIPSetCommandInput for more details

Parameter	Type	Description
`ChangeToken` Required	`string \| undefined`	The value returned by the most recent call to GetChangeToken.
`IPSetId` Required	`string \| undefined`	The `IPSetId` of the IPSet that you want to delete. `IPSetId` is returned by CreateIPSet and by ListIPSets.

DeleteIPSetCommand Output

See DeleteIPSetCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`ChangeToken`	`string \| undefined`	The `ChangeToken` that you used to submit the `DeleteIPSet` request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Throws

Name	Fault	Details
WAFInternalErrorException	server	The operation failed because of a system problem, even though the request was valid. Retry your request.
WAFInvalidAccountException	client	The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
WAFNonEmptyEntityException	client	The operation failed because you tried to delete an object that isn't empty. For example: You tried to delete a `WebACL` that still contains one or more `Rule` objects. You tried to delete a `Rule` that still contains one or more `ByteMatchSet` objects or other predicates. You tried to delete a `ByteMatchSet` that contains one or more `ByteMatchTuple` objects. You tried to delete an `IPSet` that references one or more IP addresses.
WAFNonexistentItemException	client	The operation failed because the referenced object doesn't exist.
WAFReferencedItemException	client	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 a `Rule`. You tried to delete a `Rule` that is still referenced by a `WebACL`.
WAFStaleDataException	client	The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
WAFServiceException		Base exception class for all service exceptions from WAF service.