GETCPLNCDETAILSBYRESOURCE()`¶

About GetComplianceDetailsByResource¶

Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.

Method Signature¶

METHODS /AWS1/IF_CFS~GETCPLNCDETAILSBYRESOURCE
  IMPORTING
    !IV_RESOURCETYPE TYPE /AWS1/CFSSTRWITHCHARLIMIT256 OPTIONAL
    !IV_RESOURCEID TYPE /AWS1/CFSBASERESOURCEID OPTIONAL
    !IT_COMPLIANCETYPES TYPE /AWS1/CL_CFSCOMPLIANCETYPES_W=>TT_COMPLIANCETYPES OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CFSSTRING OPTIONAL
    !IV_RESOURCEEVALUATIONID TYPE /AWS1/CFSRESOURCEEVALUATIONID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cfsgetcplncdetsbyre01
  RAISING
    /AWS1/CX_CFSINVPARAMVALUEEX
    /AWS1/CX_CFSCLIENTEXC
    /AWS1/CX_CFSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_resourcetype` `TYPE /AWS1/CFSSTRWITHCHARLIMIT256` `/AWS1/CFSSTRWITHCHARLIMIT256`¶

The type of the Amazon Web Services resource for which you want compliance information.

`iv_resourceid` `TYPE /AWS1/CFSBASERESOURCEID` `/AWS1/CFSBASERESOURCEID`¶

The ID of the Amazon Web Services resource for which you want compliance information.

`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_nexttoken` `TYPE /AWS1/CFSSTRING` `/AWS1/CFSSTRING`¶

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

`iv_resourceevaluationid` `TYPE /AWS1/CFSRESOURCEEVALUATIONID` `/AWS1/CFSRESOURCEEVALUATIONID`¶

The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.

You need to only provide either a ResourceEvaluationID or a ResourceID and ResourceType.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cfsgetcplncdetsbyre01` `/AWS1/CL_CFSGETCPLNCDETSBYRE01`¶

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->getcplncdetailsbyresource(
  it_compliancetypes = VALUE /aws1/cl_cfscompliancetypes_w=>tt_compliancetypes(
    ( new /aws1/cl_cfscompliancetypes_w( |string| ) )
  )
  iv_nexttoken = |string|
  iv_resourceevaluationid = |string|
  iv_resourceid = |string|
  iv_resourcetype = |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_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_CFS=>GETCPLNCDETAILSBYRESOURCE()¶