APIKeySummary - Amazon WAFV2
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

APIKeySummary

Information for a single API 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 Amazon WAF client application integration in the Amazon WAF Developer Guide.

Contents

APIKey

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: .*\S.*

Required: No

CreationTimestamp

The date and time that the key was created.

Type: Timestamp

Required: No

TokenDomains

The token domains that are defined in this API key.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 253.

Pattern: ^[\w\.\-/]+$

Required: No

Version

Internal value used by Amazon WAF to manage the key.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: