/ - AWS Config

Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.

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

Filters

object

optional

Filters the results by ConfigRuleComplianceFilters object.

ConfigRuleName

string

optional

The name of the Config rule.

>= 1 characters<= 128 characters

Match pattern:

.*\S.*

ComplianceType

enum<string>

optional

The rule compliance status.

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

Allowed values:

COMPLIANTNON_COMPLIANTNOT_APPLICABLEINSUFFICIENT_DATA

AccountId

string

optional

The 12-digit account ID of the source account.

Match pattern:

\d{12}

AwsRegion

string

optional

The source region where the data is aggregated.

>= 1 characters<= 64 characters

Limit

integer

optional

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

>= 0<= 1000

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

AggregateComplianceByConfigRules

array[object (AggregateComplianceByConfigRule) {4}]

optional

Returns a list of AggregateComplianceByConfigRule object.

ConfigRuleName

string

optional

The name of the Config rule.

>= 1 characters<= 128 characters

Match pattern:

.*\S.*

Compliance

object

optional

Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

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