paws.security.identity (version 0.1.0)

wafregional_delete_byte_match_set: Permanently deletes a ByteMatchSet

Description

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

Usage

wafregional_delete_byte_match_set(ByteMatchSetId, ChangeToken)

Arguments

ByteMatchSetId

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

ChangeToken

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

Request syntax

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

Details

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

To permanently delete a ByteMatchSet, perform the following steps:

1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.

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

3. Submit a DeleteByteMatchSet request.

Examples

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