List Api Keys
wafv2_list_api_keys | R Documentation |
Retrieves a list of the API keys that you've defined for the specified scope¶
Description¶
Retrieves a list of the API keys that you've defined for the specified scope.
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.
Usage¶
wafv2_list_api_keys(Scope, NextMarker, Limit)
Arguments¶
Scope |
[required] Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
|
NextMarker |
When you request a list of objects with a |
Limit |
The maximum number of objects that you want WAF to return for
this request. If more objects are available, in the response, WAF
provides a |
Value¶
A list with the following syntax:
list(
NextMarker = "string",
APIKeySummaries = list(
list(
TokenDomains = list(
"string"
),
APIKey = "string",
CreationTimestamp = as.POSIXct(
"2015-01-01"
),
Version = 123
)
),
ApplicationIntegrationURL = "string"
)
Request syntax¶
svc$list_api_keys(
Scope = "CLOUDFRONT"|"REGIONAL",
NextMarker = "string",
Limit = 123
)