/ - AWS Config

Returns the evaluation results for the specified Config rule for a specific resource in a 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.

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "ConfigurationAggregatorName": "string", "ConfigRuleName": "string", "AccountId": "string", "AwsRegion": "string", "ComplianceType": "COMPLIANT", "Limit": 0, "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

ConfigurationAggregatorName

string

required

The name of the configuration aggregator.

>= 1 characters<= 256 characters

Match pattern:

[\w\-]+

ConfigRuleName

string

required

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

>= 1 characters<= 128 characters

Match pattern:

.*\S.*

AccountId

string

required

The 12-digit account ID of the source account.

Match pattern:

\d{12}

AwsRegion

string

required

The source region from where the data is aggregated.

>= 1 characters<= 64 characters

ComplianceType

enum<string>

optional

The resource compliance status.

Allowed values:

COMPLIANTNON_COMPLIANTNOT_APPLICABLEINSUFFICIENT_DATA

Limit

integer

optional

The maximum number of evaluation results returned on each page. The default is 50. 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

AggregateEvaluationResults

array[object (AggregateEvaluationResult) {7}]

optional

Returns an AggregateEvaluationResults object.

EvaluationResultIdentifier

object

optional

Uniquely identifies the evaluation result.

ComplianceType

enum<string>

optional

The resource compliance status.

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

Allowed values:

COMPLIANTNON_COMPLIANTNOT_APPLICABLEINSUFFICIENT_DATA

ResultRecordedTime

string <date-time>

optional

The time when Config recorded the aggregate 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 agrregate evaluation determined the compliance.

>= 1 characters<= 256 characters

AccountId

string

optional

The 12-digit account ID of the source account.

Match pattern:

\d{12}

AwsRegion

string

optional

The source region from where the data is aggregated.

>= 1 characters<= 64 characters

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.

🟠480ValidationException

🟠481InvalidLimitException

🟠482InvalidNextTokenException

🟠483NoSuchConfigurationAggregatorException