GETCPLNCDETAILSBYCONFIGRULE()`¶

About GetComplianceDetailsByConfigRule¶

Returns the evaluation results for the specified Config 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.

Method Signature¶

METHODS /AWS1/IF_CFS~GETCPLNCDETAILSBYCONFIGRULE
  IMPORTING
    !IV_CONFIGRULENAME TYPE /AWS1/CFSSTRINGWITHCHARLIMIT64 OPTIONAL
    !IT_COMPLIANCETYPES TYPE /AWS1/CL_CFSCOMPLIANCETYPES_W=>TT_COMPLIANCETYPES OPTIONAL
    !IV_LIMIT TYPE /AWS1/CFSLIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CFSNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cfsgetcplncdetsbycf01
  RAISING
    /AWS1/CX_CFSINVALIDNEXTTOKENEX
    /AWS1/CX_CFSINVPARAMVALUEEX
    /AWS1/CX_CFSNOSUCHCONFIGRULEEX
    /AWS1/CX_CFSCLIENTEXC
    /AWS1/CX_CFSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_configrulename` `TYPE /AWS1/CFSSTRINGWITHCHARLIMIT64` `/AWS1/CFSSTRINGWITHCHARLIMIT64`¶

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

Optional arguments:¶

`it_compliancetypes` `TYPE /AWS1/CL_CFSCOMPLIANCETYPES_W=>TT_COMPLIANCETYPES` `TT_COMPLIANCETYPES`¶

Filters the results by compliance.

INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.

`iv_limit` `TYPE /AWS1/CFSLIMIT` `/AWS1/CFSLIMIT`¶

The maximum number of evaluation results returned on each page. The default is 10. 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_cfsgetcplncdetsbycf01` `/AWS1/CL_CFSGETCPLNCDETSBYCF01`¶

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->getcplncdetailsbyconfigrule(
  it_compliancetypes = VALUE /aws1/cl_cfscompliancetypes_w=>tt_compliancetypes(
    ( new /aws1/cl_cfscompliancetypes_w( |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_evaluationresults( ) 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_string = lo_row_1->get_resulttoken( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_CFS=>GETCPLNCDETAILSBYCONFIGRULE()¶