waf_delete_byte_match_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 a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).

If you just want to remove a ByteMatchSet from a Rule, use update_rule.

To permanently delete a ByteMatchSet, perform the following steps:

Update the ByteMatchSet to remove filters, if any. For more information, see update_byte_match_set.
Use get_change_token to get the change token that you provide in the ChangeToken parameter of a delete_byte_match_set request.
Submit a delete_byte_match_set request.

Usage

waf_delete_byte_match_set(ByteMatchSetId, ChangeToken)

Arguments

ByteMatchSetId

[required] The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by create_byte_match_set and by list_byte_match_sets.

ChangeToken

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

Value

A list with the following syntax:

list(
  ChangeToken = "string"
)

Request syntax

svc$delete_byte_match_set(
  ByteMatchSetId = "string",
  ChangeToken = "string"
)

Examples

Run this code

# NOT RUN {
# The following example deletes a byte match set with the ID
# exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.
svc$delete_byte_match_set(
  ByteMatchSetId = "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
  ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
)
# }
# NOT RUN {
# }