delete_size_constraint_set

WAFRegional.Client.delete_size_constraint_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 SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters).

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

To permanently delete a SizeConstraintSet , perform the following steps:

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

See also: AWS API Documentation

Request Syntax

response = client.delete_size_constraint_set(
    SizeConstraintSetId='string',
    ChangeToken='string'
)
Parameters
  • SizeConstraintSetId (string) --

    [REQUIRED]

    The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

  • 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 DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Exceptions

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

Examples

The following example deletes a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

response = client.delete_size_constraint_set(
    ChangeToken='abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    SizeConstraintSetId='example1ds3t-46da-4fdb-b8d5-abc321j569j5',
)

print(response)

Expected Output:

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