/

POST

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.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
  "EvaluationResults": [],
  "NextToken": "string"
}

Request

Query Params

Limit

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

<p/>

ConfigRuleName

string

required

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

>= 1 characters<= 64 characters

ComplianceTypes

array[string]

optional

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.

>= 0 items<= 3 items

Allowed values:

COMPLIANTNON_COMPLIANTNOT_APPLICABLEINSUFFICIENT_DATA

Limit

integer

optional

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.

>= 0<= 100

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/>

EvaluationResults

array[object (EvaluationResult) {6}]

optional

Indicates whether the Amazon Web Services resource complies with the specified Config rule.

EvaluationResultIdentifier

object

optional

Uniquely identifies the evaluation result.

ComplianceType

enum<string>

optional

Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.

For the EvaluationResult data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

Allowed values:

COMPLIANTNON_COMPLIANTNOT_APPLICABLEINSUFFICIENT_DATA

ResultRecordedTime

string <date-time>

optional

The time when Config recorded the evaluation result.

ConfigRuleInvokedTime

string <date-time>

optional

The time when the Config rule evaluated the Amazon Web Services resource.

Annotation

string

optional

Supplementary information about how the evaluation determined the compliance.

>= 1 characters<= 256 characters

ResultToken

string

optional

An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.

NextToken

string

optional

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

🟠480InvalidParameterValueException

🟠481InvalidNextTokenException

🟠482NoSuchConfigRuleException

Modified at 2023-08-15 05:59:06