DESCRIBERULEGROUPSUMMARY()`¶

About DescribeRuleGroupSummary¶

Returns detailed information for a stateful rule group.

For active threat defense Amazon Web Services managed rule groups, this operation provides insight into the protections enabled by the rule group, based on Suricata rule metadata fields. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.

To modify how threat information appears in summaries, use the SummaryConfiguration parameter in UpdateRuleGroup.

Method Signature¶

IMPORTING¶

Optional arguments:¶

`iv_rulegroupname` `TYPE /AWS1/NWFRESOURCENAME` `/AWS1/NWFRESOURCENAME`¶

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

`iv_rulegrouparn` `TYPE /AWS1/NWFRESOURCEARN` `/AWS1/NWFRESOURCEARN`¶

Required. The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

`iv_type` `TYPE /AWS1/NWFRULEGROUPTYPE` `/AWS1/NWFRULEGROUPTYPE`¶

The type of rule group you want a summary for. This is a required field.

Valid value: STATEFUL

Note that STATELESS exists but is not currently supported. If you provide STATELESS, an exception is returned.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_nwfdescrrlgrpsummrsp` `/AWS1/CL_NWFDESCRRLGRPSUMMRSP`¶

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->/aws1/if_nwf~describerulegroupsummary(
  iv_rulegrouparn = |string|
  iv_rulegroupname = |string|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_resourcename = lo_result->get_rulegroupname( ).
  lv_description = lo_result->get_description( ).
  lo_summary = lo_result->get_summary( ).
  IF lo_summary IS NOT INITIAL.
    LOOP AT lo_summary->get_rulesummaries( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_collectionmember_string = lo_row_1->get_sid( ).
        lv_collectionmember_string = lo_row_1->get_msg( ).
        lv_collectionmember_string = lo_row_1->get_metadata( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/IF_NWF=>DESCRIBERULEGROUPSUMMARY()¶