AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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:

  1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.

  3. Submit a DeleteIPSet request.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DeleteIPSetAsync.

Namespace: Amazon.WAF
Assembly: AWSSDK.WAF.dll
Version: 3.x.y.z

Syntax

C#
public virtual DeleteIPSetResponse DeleteIPSet(
         DeleteIPSetRequest request
)
Parameters
request
Type: Amazon.WAF.Model.DeleteIPSetRequest

Container for the necessary parameters to execute the DeleteIPSet service method.

Return Value
The response from the DeleteIPSet service method, as returned by WAF.

Exceptions

ExceptionCondition
WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
WAFNonEmptyEntityException 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 The operation failed because the referenced object doesn't exist.
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 a Rule. You tried to delete a Rule that is still referenced by a WebACL.
WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

Examples

The following example deletes an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

To delete an IP set


var response = client.DeleteIPSet(new DeleteIPSetRequest 
{
    ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
    IPSetId = "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
});

string changeToken = response.ChangeToken;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also