Uses a rule in an account group or in a 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 rule, call the ListAggregateConfigRuleEvaluationResults operation. For more information, see ListAggregateConfigRuleEvaluationResults.

The sample request in this topic shows you how to use the cr-c169626622af009f**** rule in the ca-3a58626622af0005**** account group to evaluate resources.

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 StartAggregateConfigRuleEvaluation

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

ConfigRuleId String No cr-c169626622af009f****

The ID of the rule.

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

AggregatorId String Yes ca-3a58626622af0005****

The ID of the account group.

For more information about how to obtain the ID of an account group, see ListAggregators.

RevertEvaluation Boolean No false

Specifies whether to re-evaluate the ignored non-compliant resource. Valid values:

  • true: re-evaluates the ignored non-compliant resource based on the rule.
  • false: continues to ignore the resource in the compliance evaluation based on the rule.
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 ListAggregateCompliancePacks.

Note You must set either the CompliancePackId or ConfigRuleId parameter.

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

Response parameters

Parameter Type Example Description
RequestId String ABC0FFF8-0B44-40C6-8BBF-3A185EFDD212

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=StartAggregateConfigRuleEvaluation
&ConfigRuleId=cr-c169626622af009f****
&AggregatorId=ca-3a58626622af0005****
&RevertEvaluation=false
&<Common request parameters>

Sample success responses

XML format 

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

<StartAggregateConfigRuleEvaluationResponse>
    <RequestId>ABC0FFF8-0B44-40C6-8BBF-3A185EFDD212</RequestId>
    <Result>true</Result>
</StartAggregateConfigRuleEvaluationResponse>

JSON format 

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

{
  "RequestId" : "ABC0FFF8-0B44-40C6-8BBF-3A185EFDD212",
  "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.
400 Invalid.AggregatorId.Value The specified AggregatorId is invalid. The error message returned because the specified account group ID does not exist or you are not authorized to use the account group.
403 AggregatorMemberNoPermission The aggregator member is not authorized to perform the operation. The error message returned because you are using a member account and 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.