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

*********************
get_decrypted_api_key
*********************



.. py:method:: WAFV2.Client.get_decrypted_api_key(**kwargs)

  

  Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.

   

  API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see `WAF client application integration <https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html>`__ in the *WAF Developer Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/GetDecryptedAPIKey>`_  


  **Request Syntax**
  ::

    response = client.get_decrypted_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.

    

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

    
    ::

      {
          'TokenDomains': [
              'string',
          ],
          'CreationTimestamp': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **TokenDomains** *(list) --* 

        The token domains that are defined in this API key.

        
        

        - *(string) --* 
    
      

      - **CreationTimestamp** *(datetime) --* 

        The date and time that the key was created.

        
  
  **Exceptions**
  
  *   :py:class:`WAFV2.Client.exceptions.WAFInternalErrorException`

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

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

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

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

  