paws.security.identity (version 0.1.12)

waf_delete_ip_set: This is AWS WAF Classic documentation

Description

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 update_rule.

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 update_ip_set.

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

3. Submit a delete_ip_set request.

Usage

waf_delete_ip_set(IPSetId, ChangeToken)

Value

A list with the following syntax:

list(
  ChangeToken = "string"
)

Arguments

IPSetId

[required] The IPSetId of the IPSet that you want to delete. IPSetId is returned by create_ip_set and by list_ip_sets.

ChangeToken

[required] The value returned by the most recent call to get_change_token.

Request syntax

svc$delete_ip_set(
  IPSetId = "string",
  ChangeToken = "string"
)

Examples

if (FALSE) {
# The following example deletes an IP match set  with the ID
# example1ds3t-46da-4fdb-b8d5-abc321j569j5.
svc$delete_ip_set(
  ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
  IPSetId = "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
)
}