resource_evaluation_summaries

Creates, updates, deletes, gets or lists a resource_evaluation_summaries resource.

Overview

Name	resource_evaluation_summaries
Type	Resource
Id	aws.config.resource_evaluation_summaries

Fields

The following fields are returned by SELECT queries:

get_resource_evaluation_summary

Name	Datatype	Description
compliance	string	The compliance status of the resource evaluation summary. (COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA)
evaluation_context	object	Returns an EvaluationContext object.
evaluation_mode	string	Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive. (DETECTIVE, PROACTIVE)
evaluation_start_timestamp	string (date-time)	The start timestamp when Config rule starts evaluating compliance for the provided resource details.
evaluation_status	object	Returns an EvaluationStatus object.
resource_details	object	Returns a ResourceDetails object.
resource_evaluation_id	string	The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_resource_evaluation_summary	select	region		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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_resource_evaluation_summary

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.

SELECT
compliance,
evaluation_context,
evaluation_mode,
evaluation_start_timestamp,
evaluation_status,
resource_details,
resource_evaluation_id
FROM aws.config.resource_evaluation_summaries
WHERE region = '{{ region }}' -- required
;