/ - AWS Config

Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action 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.

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "ConfigRuleNames": [], "ComplianceTypes": [], "NextToken": "string" }'

Request

Query Params

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

<p/>

ConfigRuleNames

array[string]

optional

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

>= 0 items<= 25 items

ComplianceTypes

array[string]

optional

Filters the results by compliance.

>= 0 items<= 3 items

Allowed values:

COMPLIANTNON_COMPLIANTNOT_APPLICABLEINSUFFICIENT_DATA

NextToken

string

optional

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

Examples

Responses

🟢200Success

application/json

Body

<p/>

ComplianceByConfigRules

array[object (ComplianceByConfigRule) {2}]

optional

Indicates whether each of the specified Config rules is compliant.

ConfigRuleName

string

optional

The name of the Config rule.

>= 1 characters<= 64 characters

Compliance

object

optional

Indicates whether the Config rule is compliant.

NextToken

string

optional

The string that you use in a subsequent request to get the next page of results in a paginated response.

🟠480InvalidParameterValueException

🟠481NoSuchConfigRuleException

🟠482InvalidNextTokenException