Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.
To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetailsByResource API. For more information, see the Examples section.
Parameters:
-
resource_evaluation_id
(ResourceEvaluationId)
–
The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.
Raises:
Source code in docs_src/capo_config_service/_services/config_service.py
| def get_resource_evaluation_summary(
self,
resource_evaluation_id: "capo_config_service.types.resource_evaluation_id.ResourceEvaluationId",
*,
config_overrides: Optional[ConfigServiceClientConfig] = None,
) -> "capo_config_service.types.get_resource_evaluation_summary_response.GetResourceEvaluationSummaryResponse":
"""<p>Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules. </p> <note> <p>To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_GetComplianceDetailsByResource.html">GetComplianceDetailsByResource</a> API. For more information, see the <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_GetResourceEvaluationSummary.html#API_GetResourceEvaluationSummary_Examples">Examples</a> section.</p> </note>
Args:
resource_evaluation_id: <p>The unique <code>ResourceEvaluationId</code> of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.</p>
Raises:
capo_config_service.errors.resource_not_found_exception.ResourceNotFoundException: <p>You have specified a resource that does not exist.</p>
capo_config_service.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_config_service.types.get_resource_evaluation_summary_request.GetResourceEvaluationSummaryRequest]",
) -> OperationResponse[
"capo_config_service.types.get_resource_evaluation_summary_response.GetResourceEvaluationSummaryResponse"
]:
import capo_config_service._operations.starling_dove_service.get_resource_evaluation_summary
output, http_response = (
capo_config_service._operations.starling_dove_service.get_resource_evaluation_summary.get_resource_evaluation_summary(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetResourceEvaluationSummary")
)
input_: capo_config_service.types.get_resource_evaluation_summary_request.GetResourceEvaluationSummaryRequest = {
"resource_evaluation_id": resource_evaluation_id
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|