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.

See also: AWS API Documentation

Request Syntax

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

  • Scope (string) –

    [REQUIRED]

    Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

    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:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions