:doc:`WAFV2 <../../wafv2>` / Client / delete_api_key

**************
delete_api_key
**************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/DeleteAPIKey>`_  


  **Request Syntax**
  ::

    response = client.delete_api_key(
        Scope='CLOUDFRONT'|'REGIONAL',
        APIKey='string'
    )
    
  :type Scope: string
  :param Scope: **[REQUIRED]** 

    Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use ``CLOUDFRONT``.

     

    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.
    

    

  
  :type APIKey: string
  :param APIKey: **[REQUIRED]** 

    The encrypted API key that you want to delete.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`WAFV2.Client.exceptions.WAFInternalErrorException`

  
  *   :py:class:`WAFV2.Client.exceptions.WAFNonexistentItemException`

  
  *   :py:class:`WAFV2.Client.exceptions.WAFOptimisticLockException`

  
  *   :py:class:`WAFV2.Client.exceptions.WAFInvalidParameterException`

  
  *   :py:class:`WAFV2.Client.exceptions.WAFInvalidOperationException`

  