Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1492542448.2 KB

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.

The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.

post/#X-Amz-Target=StarlingDoveService.GetAggregateComplianceDetailsByConfigRule

Query parameters

Limitstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'StarlingDoveService.GetAggregateComplianceDetailsByConfigRule' required

Request body

ConfigurationAggregatorNamestring required

The name of the configuration aggregator.

ConfigRuleNamestring required

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

AccountIdstring required

The 12-digit account ID of the source account.

AwsRegionstring required

The source region from where the data is aggregated.

ComplianceType'COMPLIANT' | 'NON_COMPLIANT' | 'NOT_APPLICABLE' | 'INSUFFICIENT_DATA'
<p>The resource compliance status.</p> <note> <p>For the <code>GetAggregateComplianceDetailsByConfigRuleRequest</code> data type, Config supports only the <code>COMPLIANT</code> and <code>NON_COMPLIANT</code>. Config does not support the <code>NOT_APPLICABLE</code> and <code>INSUFFICIENT_DATA</code> values.</p> </note>
Limitinteger

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.

NextTokenstring

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

Response

Success

NextTokenstring

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