LISTPROTECTIONGROUPS()`¶

About ListProtectionGroups¶

Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.

Method Signature¶

METHODS /AWS1/IF_SHD~LISTPROTECTIONGROUPS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/SHDTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SHDMAXRESULTS OPTIONAL
    !IO_INCLUSIONFILTERS TYPE REF TO /AWS1/CL_SHDINCLUSIONPROTECT00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_shdlstprotectiongrs01
  RAISING
    /AWS1/CX_SHDINTERNALERROREX
    /AWS1/CX_SHDINVPAGINATIONTOKEX
    /AWS1/CX_SHDRESOURCENOTFOUNDEX
    /AWS1/CX_SHDCLIENTEXC
    /AWS1/CX_SHDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/SHDTOKEN` `/AWS1/SHDTOKEN`¶

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

`iv_maxresults` `TYPE /AWS1/SHDMAXRESULTS` `/AWS1/SHDMAXRESULTS`¶

The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

The default setting is 20.

`io_inclusionfilters` `TYPE REF TO /AWS1/CL_SHDINCLUSIONPROTECT00` `/AWS1/CL_SHDINCLUSIONPROTECT00`¶

Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with specific pattern or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_shdlstprotectiongrs01` `/AWS1/CL_SHDLSTPROTECTIONGRS01`¶

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->listprotectiongroups(
  io_inclusionfilters = new /aws1/cl_shdinclusionprotect00(
    it_aggregations = VALUE /aws1/cl_shdprotectiongraggf00=>tt_protectiongroupaggrfilters(
      ( new /aws1/cl_shdprotectiongraggf00( |string| ) )
    )
    it_patterns = VALUE /aws1/cl_shdprotectiongrpatf00=>tt_protectiongrouppatfilters(
      ( new /aws1/cl_shdprotectiongrpatf00( |string| ) )
    )
    it_protectiongroupids = VALUE /aws1/cl_shdprotectiongridfi00=>tt_protectiongroupidfilters(
      ( new /aws1/cl_shdprotectiongridfi00( |string| ) )
    )
    it_resourcetypes = VALUE /aws1/cl_shdprotectedresrcty00=>tt_protectedresrctypefilters(
      ( new /aws1/cl_shdprotectedresrcty00( |string| ) )
    )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_protectiongroups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_protectiongroupid = lo_row_1->get_protectiongroupid( ).
      lv_protectiongroupaggregat = lo_row_1->get_aggregation( ).
      lv_protectiongrouppattern = lo_row_1->get_pattern( ).
      lv_protectedresourcetype = lo_row_1->get_resourcetype( ).
      LOOP AT lo_row_1->get_members( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_resourcearn = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_resourcearn = lo_row_1->get_protectiongrouparn( ).
    ENDIF.
  ENDLOOP.
  lv_token = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_SHD=>LISTPROTECTIONGROUPS()¶