Skip to content

/AWS1/IF_CFS=>GETAGGREGATECPLNCDETSBYCFGRL()

About GetAggregateComplianceDetailsByConfigRule

Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

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~GETAGGREGATECPLNCDETSBYCFGRL
  IMPORTING
    !IV_CONFAGGREGATORNAME TYPE /AWS1/CFSCONFAGGREGATORNAME OPTIONAL
    !IV_CONFIGRULENAME TYPE /AWS1/CFSCONFIGRULENAME OPTIONAL
    !IV_ACCOUNTID TYPE /AWS1/CFSACCOUNTID OPTIONAL
    !IV_AWSREGION TYPE /AWS1/CFSAWSREGION OPTIONAL
    !IV_COMPLIANCETYPE TYPE /AWS1/CFSCOMPLIANCETYPE OPTIONAL
    !IV_LIMIT TYPE /AWS1/CFSLIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CFSNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cfsgetaggregatecpln01
  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.

iv_configrulename TYPE /AWS1/CFSCONFIGRULENAME /AWS1/CFSCONFIGRULENAME

The name of the Config rule for which you want compliance information.

iv_accountid TYPE /AWS1/CFSACCOUNTID /AWS1/CFSACCOUNTID

The 12-digit account ID of the source account.

iv_awsregion TYPE /AWS1/CFSAWSREGION /AWS1/CFSAWSREGION

The source region from where the data is aggregated.

Optional arguments:

iv_compliancetype TYPE /AWS1/CFSCOMPLIANCETYPE /AWS1/CFSCOMPLIANCETYPE

The resource compliance status.

For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

iv_limit TYPE /AWS1/CFSLIMIT /AWS1/CFSLIMIT

The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. 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_cfsgetaggregatecpln01 /AWS1/CL_CFSGETAGGREGATECPLN01

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->getaggregatecplncdetsbycfgrl(
  iv_accountid = |string|
  iv_awsregion = |string|
  iv_compliancetype = |string|
  iv_confaggregatorname = |string|
  iv_configrulename = |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.
  LOOP AT lo_result->get_aggregateevalresults( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_evaluationresultidentif = lo_row_1->get_evalresultidentifier( ).
      IF lo_evaluationresultidentif IS NOT INITIAL.
        lo_evaluationresultqualifi = lo_evaluationresultidentif->get_evalresultqualifier( ).
        IF lo_evaluationresultqualifi IS NOT INITIAL.
          lv_configrulename = lo_evaluationresultqualifi->get_configrulename( ).
          lv_stringwithcharlimit256 = lo_evaluationresultqualifi->get_resourcetype( ).
          lv_baseresourceid = lo_evaluationresultqualifi->get_resourceid( ).
          lv_evaluationmode = lo_evaluationresultqualifi->get_evaluationmode( ).
        ENDIF.
        lv_date = lo_evaluationresultidentif->get_orderingtimestamp( ).
        lv_resourceevaluationid = lo_evaluationresultidentif->get_resourceevaluationid( ).
      ENDIF.
      lv_compliancetype = lo_row_1->get_compliancetype( ).
      lv_date = lo_row_1->get_resultrecordedtime( ).
      lv_date = lo_row_1->get_configruleinvokedtime( ).
      lv_stringwithcharlimit256 = lo_row_1->get_annotation( ).
      lv_accountid = lo_row_1->get_accountid( ).
      lv_awsregion = lo_row_1->get_awsregion( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.