WAFV2 / Client / delete_api_key

delete_api_key#

WAFV2.Client.delete_api_key(**kwargs)#

Deletes the specified API key.

After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.

response = client.delete_api_key(
    Scope='CLOUDFRONT'|'REGIONAL',
    APIKey='string'
)

Parameters:

Scope (string) –
[REQUIRED]

Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
- API and SDKs - For all calls, use the Region endpoint us-east-1.
APIKey (string) –
[REQUIRED]

The encrypted API key that you want to delete.

Return type:

dict

Returns:

{}