Skip to main content

decrypted_api_keys

Creates, updates, deletes, gets or lists a decrypted_api_keys resource.

Overview

Namedecrypted_api_keys
TypeResource
Idaws.wafv2.decrypted_api_keys

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
creation_timestampstring (date-time)The date and time that the key was created.
token_domainsarrayThe token domains that are defined in this API key.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_decrypted_api_keyselectregionReturns 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 in the WAF Developer Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

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 in the WAF Developer Guide.

SELECT
creation_timestamp,
token_domains
FROM aws.wafv2.decrypted_api_keys
WHERE region = '{{ region }}' -- required
;