All Products
Search

This Product

    Cloud Config:StartAggregateConfigRuleEvaluation

    Document Center

    Cloud Config:StartAggregateConfigRuleEvaluation

    Last Updated:Jul 02, 2024

    Re-evaluates the compliance of resources based on a rule or based on all rules in a compliance package in a specific account group.

    Operation description

    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 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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ConfigRuleIdstringNo

    The rule ID.

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

    Note You must configure either the CompliancePackId or ConfigRuleId parameter.
    		cr-c169626622af009f****
    AggregatorIdstringYes

    The ID of the account group.

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

    		ca-3a58626622af0005****
    RevertEvaluationbooleanNo

    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 (default): does not re-evaluate the ignored non-compliant resource based on the rule.
    		false
    CompliancePackIdstringNo

    The ID of the compliance package.

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

    Note You must configure either the CompliancePackId or ConfigRuleId parameter.
    		cp-ac16626622af0053****

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

    Response parameters

    ParameterTypeDescriptionExample
    object

    N/A.

    RequestIdstring

    The request ID.

    		ABC0FFF8-0B44-40C6-8BBF-3A185EFDD212
    Resultboolean

    Indicates whether the involved resources were evaluated. Valid values:

    • true: The involved resources were evaluated.
    • false: The involved resources were not evaluated
    		true

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "ABC0FFF8-0B44-40C6-8BBF-3A185EFDD212",
  "Result": true
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ConfigRuleNotExistsThe ConfigRule does not exist.The rule does not exist.
    400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
    400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.The specified aggregator ID does not exist or you are not authorized to use the aggregator.
    403AggregatorMemberNoPermissionThe aggregator member is not authorized to perform the operation.The aggregator member is not authorized to perform the operation.
    404AccountNotExistedYour account does not exist.The specified account does not exist.
    503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

    For a list of error codes, visit the Service error codes.