/ - AWS Config

Returns compliance details for each rule in that conformance pack.

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "ConformancePackName": "string", "Filters": { "ConfigRuleNames": [], "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

ConformancePackName

string

required

Name of the conformance pack.

>= 1 characters<= 256 characters

Match pattern:

[a-zA-Z][-a-zA-Z0-9]*

Filters

object

optional

A ConformancePackComplianceFilters object.

ConfigRuleNames

array[string]

optional

Filters the results by Config rule names.

>= 0 items<= 10 items

ComplianceType

enum<string>

optional

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

Allowed values:

COMPLIANTNON_COMPLIANTINSUFFICIENT_DATA

Limit

integer

optional

The maximum number of Config rules within a conformance pack are returned on each page.

>= 0<= 1000

NextToken

string

optional

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

Examples

Responses

🟢200Success

application/json

Body

ConformancePackName

string

required

Name of the conformance pack.

>= 1 characters<= 256 characters

Match pattern:

[a-zA-Z][-a-zA-Z0-9]*

ConformancePackRuleComplianceList

array[object (ConformancePackRuleCompliance) {3}]

required

Returns a list of ConformancePackRuleCompliance objects.

>= 0 items<= 1000 items

ConfigRuleName

string

optional

Name of the Config rule.

>= 1 characters<= 128 characters

Match pattern:

.*\S.*

ComplianceType

enum<string>

optional

Compliance of the Config rule.

Allowed values:

COMPLIANTNON_COMPLIANTINSUFFICIENT_DATA

Controls

array[string]

optional

Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map to internal controls defined by an organization.

>= 0 items<= 20 items

NextToken

string

optional

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

🟠480InvalidLimitException

🟠481InvalidNextTokenException

🟠482InvalidParameterValueException

🟠483NoSuchConfigRuleInConformancePackException

🟠484NoSuchConformancePackException