WAFV2 / Client / get_decrypted_api_key

get_decrypted_api_key#

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.

Request Syntax

response = client.get_decrypted_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, or an App Runner service.

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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

Exceptions