Uses a specified rule or the rules in a specified compliance package to evaluate the compliance of resources.

Note After you call this operation, the compliance evaluation is performed only once. To query the compliance evaluation results returned by the specified rule or compliance package, call the ListConfigRuleEvaluationResults operation. For more information, see ListConfigRuleEvaluationResults.

In this example, the cr-bdb6626622af0012**** rule is used.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes StartConfigRuleEvaluation

The operation that you want to perform. Set the value to StartConfigRuleEvaluation.

ConfigRuleId String No cr-bdb6626622af0012****

The ID of the rule.

For more information about how to obtain the ID of a rule, see ListConfigRules.

RevertEvaluation Boolean No false

Specifies whether to reevaluate a non-compliant resource that is ignored. Valid values:

  • true: reevaluates a non-compliant resource that is ignored.
  • false: continues to ignore a non-compliant resource.
CompliancePackId String No cp-ac16626622af0053****

The ID of the compliance package.

For more information about how to obtain the ID of a compliance package, see ListCompliancePacks.

Note You must set one of the CompliancePackId and ConfigRuleId parameters.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String C32EEAD7-BF64-5927-977A-AFF9342B7275

The ID of the request.

Result Boolean true

Indicates whether the operation is successful. Valid values:

  • true: The operation is successful.
  • false: The operation fails.

Examples

Sample requests

http(s)://[Endpoint]/?Action=StartConfigRuleEvaluation
&ConfigRuleId=cr-bdb6626622af0012****
&RevertEvaluation=false
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<StartConfigRuleEvaluationResponse>
    <RequestId>C32EEAD7-BF64-5927-977A-AFF9342B7275</RequestId>
    <Result>true</Result>
</StartConfigRuleEvaluationResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C32EEAD7-BF64-5927-977A-AFF9342B7275",
  "Result" : true
}

Error codes

HTTP status code Error code Error message Description
400 ConfigRuleNotExists The ConfigRule does not exist. The error message returned because the specified rule does not exist.
400 NoPermission You are not authorized to perform this operation. The error message returned because you are not authorized to perform the specified operation.
404 AccountNotExisted Your account does not exist. The error message returned because your account does not exist.
503 ServiceUnavailable The request has failed due to a temporary failure of the server. The error message returned because the service is unavailable.

For a list of error codes, visit the API Error Center.