LISTRULEGROUPS()`¶

About ListRuleGroups¶

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of RuleGroup objects.

Method Signature¶

METHODS /AWS1/IF_WAF~LISTRULEGROUPS
  IMPORTING
    !IV_NEXTMARKER TYPE /AWS1/WAFNEXTMARKER OPTIONAL
    !IV_LIMIT TYPE /AWS1/WAFPAGINATIONLIMIT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_waflistrulegroupsrsp
  RAISING
    /AWS1/CX_WAFWAFINTERNALERROREX
    /AWS1/CX_WAFCLIENTEXC
    /AWS1/CX_WAFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nextmarker` `TYPE /AWS1/WAFNEXTMARKER` `/AWS1/WAFNEXTMARKER`¶

If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups.

`iv_limit` `TYPE /AWS1/WAFPAGINATIONLIMIT` `/AWS1/WAFPAGINATIONLIMIT`¶

Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_waflistrulegroupsrsp` `/AWS1/CL_WAFLISTRULEGROUPSRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

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->listrulegroups(
  iv_limit = 123
  iv_nextmarker = |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_rulegroups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_resourceid = lo_row_1->get_rulegroupid( ).
      lv_resourcename = lo_row_1->get_name( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_WAF=>LISTRULEGROUPS()¶