/

POST

Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.

A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

If Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission.
The rule's Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ResourceType": "string",
    "ResourceId": "string",
    "ComplianceTypes": [],
    "Limit": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

{
    "ComplianceByResources": [],
    "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

<p/>

ResourceType

string

optional

The types of Amazon Web Services resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

>= 1 characters<= 256 characters

ResourceId

string

optional

The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

>= 1 characters<= 768 characters

ComplianceTypes

array[string]

optional

Filters the results by compliance.

>= 0 items<= 3 items

Allowed values:

COMPLIANTNON_COMPLIANTNOT_APPLICABLEINSUFFICIENT_DATA

Limit

integer

optional

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

<p/>

ComplianceByResources

array[object (ComplianceByResource) {3}]

optional

Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.

ResourceType

string

optional

The type of the Amazon Web Services resource that was evaluated.

>= 1 characters<= 256 characters

ResourceId

string

optional

The ID of the Amazon Web Services resource that was evaluated.

>= 1 characters<= 768 characters

Compliance

object

optional

Indicates whether the Amazon Web Services resource complies with all of the Config rules that evaluated it.

NextToken

string

optional

The string that you use in a subsequent request to get the next page of results in a paginated response.

🟠480InvalidParameterValueException

🟠481InvalidNextTokenException

Modified at 2023-08-15 05:59:06