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¶

METHODS /AWS1/IF_WA2~LISTAPIKEYS
  IMPORTING
    !IV_SCOPE TYPE /AWS1/WA2SCOPE OPTIONAL
    !IV_NEXTMARKER TYPE /AWS1/WA2NEXTMARKER OPTIONAL
    !IV_LIMIT TYPE /AWS1/WA2PAGINATIONLIMIT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wa2listapikeysrsp
  RAISING
    /AWS1/CX_WA2WAFINTERNALERROREX
    /AWS1/CX_WA2WAFINVALIDOPEX
    /AWS1/CX_WA2WAFINVALIDPARAMEX
    /AWS1/CX_WA2WAFINVRESOURCEEX
    /AWS1/CX_WA2CLIENTEXC
    /AWS1/CX_WA2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_scope` `TYPE /AWS1/WA2SCOPE` `/AWS1/WA2SCOPE`¶

Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

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`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listapikeys(
  iv_limit = 123
  iv_nextmarker = |string|
  iv_scope = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nextmarker = lo_result->get_nextmarker( ).
  LOOP AT lo_result->get_apikeysummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      LOOP AT lo_row_1->get_tokendomains( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_tokendomain = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_apikey = lo_row_1->get_apikey( ).
      lv_timestamp = lo_row_1->get_creationtimestamp( ).
      lv_apikeyversion = lo_row_1->get_version( ).
    ENDIF.
  ENDLOOP.
  lv_outputurl = lo_result->get_applicationintegration00( ).
ENDIF.

/AWS1/IF_WA2=>LISTAPIKEYS()¶