delete_byte_match_set

delete_byte_match_set(**kwargs)

Note

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

To permanently delete a ByteMatchSet , perform the following steps:

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

See also: AWS API Documentation

Request Syntax

response = client.delete_byte_match_set(
    ByteMatchSetId='string',
    ChangeToken='string'
)

Parameters

• ByteMatchSetId (string) --

  [REQUIRED]

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

• ChangeToken (string) --

  [REQUIRED]

  The value returned by the most recent call to GetChangeToken.

Return type

dict

Returns

Response Syntax

{
    'ChangeToken': 'string'
}

Response Structure

• (dict) --

  • ChangeToken (string) --

    The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Exceptions

• WAF.Client.exceptions.WAFInternalErrorException
• WAF.Client.exceptions.WAFInvalidAccountException
• WAF.Client.exceptions.WAFNonexistentItemException
• WAF.Client.exceptions.WAFReferencedItemException
• WAF.Client.exceptions.WAFStaleDataException
• WAF.Client.exceptions.WAFNonEmptyEntityException

Examples

The following example deletes a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.

response = client.delete_byte_match_set(
    ByteMatchSetId='exampleIDs3t-46da-4fdb-b8d5-abc321j569j5',
    ChangeToken='abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
)

print(response)

Expected Output:

{
    'ChangeToken': 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'ResponseMetadata': {
        '...': '...',
    },
}