WAFRegional / Client / delete_web_acl
delete_web_acl#
- WAFRegional.Client.delete_web_acl(**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 WebACL. You can’t delete a
WebACL
if it still contains anyRules
.To delete a
WebACL
, perform the following steps:Update the
WebACL
to removeRules
, if any. For more information, see UpdateWebACL.Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteWebACL
request.Submit a
DeleteWebACL
request.
See also: AWS API Documentation
Request Syntax
response = client.delete_web_acl( WebACLId='string', ChangeToken='string' )
- Parameters:
WebACLId (string) –
[REQUIRED]
The
WebACLId
of the WebACL that you want to delete.WebACLId
is returned by CreateWebACL and by ListWebACLs.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 theDeleteWebACL
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
WAFRegional.Client.exceptions.WAFTagOperationException
WAFRegional.Client.exceptions.WAFTagOperationInternalErrorException
Examples
The following example deletes a web ACL with the ID example-46da-4444-5555-example.
response = client.delete_web_acl( ChangeToken='abcd12f2-46da-4fdb-b8d5-fbd4c466928f', WebACLId='example-46da-4444-5555-example', ) print(response)
Expected Output:
{ 'ChangeToken': 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f', 'ResponseMetadata': { '...': '...', }, }