/ - AWS Config

Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.

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

ResourceType

string

optional

Filters the results by the resource type (for example, "AWS::EC2::Instance").

>= 1 characters<= 256 characters

ResourceIds

array[string]

optional

Filters the results by resource IDs.

>= 0 items<= 5 items

Limit

integer

optional

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

>= 0<= 100

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]*

ConformancePackRuleEvaluationResults

array[object (ConformancePackEvaluationResult) {5}]

optional

Returns a list of ConformancePackEvaluationResult objects.

>= 0 items<= 100 items

ComplianceType

enum<string>

required

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

Allowed values:

COMPLIANTNON_COMPLIANTINSUFFICIENT_DATA

EvaluationResultIdentifier

object

EvaluationResultIdentifier

required

Uniquely identifies an evaluation result.

ConfigRuleInvokedTime

string <date-time>

required

The time when Config rule evaluated Amazon Web Services resource.

ResultRecordedTime

string <date-time>

required

The time when Config recorded the evaluation result.

Annotation

string

optional

Supplementary information about how the evaluation determined the compliance.

>= 0 characters<= 256 characters

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

🟠482NoSuchConformancePackException

🟠483NoSuchConfigRuleInConformancePackException

🟠484InvalidParameterValueException