GETAGGREGATECFGRULECPLNCSUMM()`¶

About GetAggregateConfigRuleComplianceSummary¶

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Method Signature¶

METHODS /AWS1/IF_CFS~GETAGGREGATECFGRULECPLNCSUMM
  IMPORTING
    !IV_CONFAGGREGATORNAME TYPE /AWS1/CFSCONFAGGREGATORNAME OPTIONAL
    !IO_FILTERS TYPE REF TO /AWS1/CL_CFSCFGRLCPLNCSUMMFI00 OPTIONAL
    !IV_GROUPBYKEY TYPE /AWS1/CFSCFGRLCPLNCSUMMGRPKEY OPTIONAL
    !IV_LIMIT TYPE /AWS1/CFSGROUPBYAPILIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CFSNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cfsgetaggregatecfgr01
  RAISING
    /AWS1/CX_CFSINVALIDLIMITEX
    /AWS1/CX_CFSINVALIDNEXTTOKENEX
    /AWS1/CX_CFSNOSUCHCONFAGGREG00
    /AWS1/CX_CFSVALIDATIONEX
    /AWS1/CX_CFSCLIENTEXC
    /AWS1/CX_CFSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_confaggregatorname` `TYPE /AWS1/CFSCONFAGGREGATORNAME` `/AWS1/CFSCONFAGGREGATORNAME`¶

The name of the configuration aggregator.

Optional arguments:¶

`io_filters` `TYPE REF TO /AWS1/CL_CFSCFGRLCPLNCSUMMFI00` `/AWS1/CL_CFSCFGRLCPLNCSUMMFI00`¶

Filters the results based on the ConfigRuleComplianceSummaryFilters object.

`iv_groupbykey` `TYPE /AWS1/CFSCFGRLCPLNCSUMMGRPKEY` `/AWS1/CFSCFGRLCPLNCSUMMGRPKEY`¶

Groups the result based on ACCOUNT_ID or AWS_REGION.

`iv_limit` `TYPE /AWS1/CFSGROUPBYAPILIMIT` `/AWS1/CFSGROUPBYAPILIMIT`¶

The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.

`iv_nexttoken` `TYPE /AWS1/CFSNEXTTOKEN` `/AWS1/CFSNEXTTOKEN`¶

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cfsgetaggregatecfgr01` `/AWS1/CL_CFSGETAGGREGATECFGR01`¶

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->getaggregatecfgrulecplncsumm(
  io_filters = new /aws1/cl_cfscfgrlcplncsummfi00(
    iv_accountid = |string|
    iv_awsregion = |string|
  )
  iv_confaggregatorname = |string|
  iv_groupbykey = |string|
  iv_limit = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_stringwithcharlimit256 = lo_result->get_groupbykey( ).
  LOOP AT lo_result->get_aggregatecplnccounts( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_stringwithcharlimit256 = lo_row_1->get_groupname( ).
      lo_compliancesummary = lo_row_1->get_compliancesummary( ).
      IF lo_compliancesummary IS NOT INITIAL.
        lo_compliancecontributorco = lo_compliancesummary->get_compliantresourcecount( ).
        IF lo_compliancecontributorco IS NOT INITIAL.
          lv_integer = lo_compliancecontributorco->get_cappedcount( ).
          lv_boolean = lo_compliancecontributorco->get_capexceeded( ).
        ENDIF.
        lo_compliancecontributorco = lo_compliancesummary->get_noncompresourcecount( ).
        IF lo_compliancecontributorco IS NOT INITIAL.
          lv_integer = lo_compliancecontributorco->get_cappedcount( ).
          lv_boolean = lo_compliancecontributorco->get_capexceeded( ).
        ENDIF.
        lv_date = lo_compliancesummary->get_cplncsummarytimestamp( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_CFS=>GETAGGREGATECFGRULECPLNCSUMM()¶