configservice_describe_compliance_by_config_rule: Indicates whether the specified AWS Config rules are compliant

Description

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

Usage

configservice_describe_compliance_by_config_rule(ConfigRuleNames,
  ComplianceTypes, NextToken)

Arguments

ConfigRuleNames

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

ComplianceTypes

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT.

NextToken

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

Request syntax

svc$describe_compliance_by_config_rule(
  ConfigRuleNames = list(
    "string"
  ),
  ComplianceTypes = list(
    "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA"
  ),
  NextToken = "string"
)

Details

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 AWS Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

AWS 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 AWS Lambda function is failing to send evaluation results to AWS 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 AWS Lambda execution role includes the config:PutEvaluations permission.
The rule's AWS 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.