/AWS1/CL_WA2=>LISTAPIKEYS()

About ListAPIKeys

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.

Method Signature

IMPORTING

Required arguments:

IV_SCOPE TYPE /AWS1/WA2SCOPE /AWS1/WA2SCOPE

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, an App Runner service, or an Amazon Web Services Verified Access instance.

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.

Optional arguments:

IV_NEXTMARKER TYPE /AWS1/WA2NEXTMARKER /AWS1/WA2NEXTMARKER

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

IV_LIMIT TYPE /AWS1/WA2PAGINATIONLIMIT /AWS1/WA2PAGINATIONLIMIT

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 NextMarker value that you can use in a subsequent call to get the next batch of objects.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_WA2LISTAPIKEYSRSP /AWS1/CL_WA2LISTAPIKEYSRSP