/AWS1/IF_CFS=>DESCRIBECPLNCBYCONFIGRULE()

About DescribeComplianceByConfigRule

Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this operation returns the number of Amazon Web Services resources that do not comply with the rule.

A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.

If Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

• Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

• The rule's Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission.

• The rule's Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Method Signature

METHODS /AWS1/IF_CFS~DESCRIBECPLNCBYCONFIGRULE
  IMPORTING
    !IT_CONFIGRULENAMES TYPE /AWS1/CL_CFSCONFIGRULENAMES_W=>TT_CONFIGRULENAMES OPTIONAL
    !IT_COMPLIANCETYPES TYPE /AWS1/CL_CFSCOMPLIANCETYPES_W=>TT_COMPLIANCETYPES OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CFSSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cfsdsccplncbycfgrlrsp
  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

Optional arguments:

it_configrulenames TYPE /AWS1/CL_CFSCONFIGRULENAMES_W=>TT_CONFIGRULENAMES TT_CONFIGRULENAMES

Specify one or more Config rule names to filter the results by rule.

it_compliancetypes TYPE /AWS1/CL_CFSCOMPLIANCETYPES_W=>TT_COMPLIANCETYPES TT_COMPLIANCETYPES

Filters the results by compliance.

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_cfsdsccplncbycfgrlrsp /AWS1/CL_CFSDSCCPLNCBYCFGRLRSP

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->describecplncbyconfigrule(
  it_compliancetypes = VALUE /aws1/cl_cfscompliancetypes_w=>tt_compliancetypes(
    ( new /aws1/cl_cfscompliancetypes_w( |string| ) )
  )
  it_configrulenames = VALUE /aws1/cl_cfsconfigrulenames_w=>tt_configrulenames(
    ( new /aws1/cl_cfsconfigrulenames_w( |string| ) )
  )
  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_compliancebyconfigrules( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_stringwithcharlimit64 = lo_row_1->get_configrulename( ).
      lo_compliance = lo_row_1->get_compliance( ).
      IF lo_compliance IS NOT INITIAL.
        lv_compliancetype = lo_compliance->get_compliancetype( ).
        lo_compliancecontributorco = lo_compliance->get_compliancecontribcount( ).
        IF lo_compliancecontributorco IS NOT INITIAL.
          lv_integer = lo_compliancecontributorco->get_cappedcount( ).
          lv_boolean = lo_compliancecontributorco->get_capexceeded( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.