aggregate_compliance_details_by_config_rules
Creates, updates, deletes, gets or lists an aggregate_compliance_details_by_config_rules resource.
Overview
| Name | aggregate_compliance_details_by_config_rules |
| Type | Resource |
| Id | aws.config.aggregate_compliance_details_by_config_rules |
Fields
The following fields are returned by SELECT queries:
- get_aggregate_compliance_details_by_config_rule
| Name | Datatype | Description |
|---|---|---|
account_id | string | The 12-digit account ID of the source account. (pattern: <code>\d{12}</code>) |
annotation | string | Supplementary information about how the agrregate evaluation determined the compliance. |
aws_region | string | The source region from where the data is aggregated. |
compliance_type | string | The resource compliance status. For the AggregationEvaluationResult data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value. (COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA) |
config_rule_invoked_time | string (date-time) | The time when the Config rule evaluated the Amazon Web Services resource. |
evaluation_result_identifier | object | Uniquely identifies the evaluation result. |
result_recorded_time | string (date-time) | The time when Config recorded the aggregate evaluation result. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_aggregate_compliance_details_by_config_rule | select | region | Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page. |
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_aggregate_compliance_details_by_config_rule
Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.
SELECT
account_id,
annotation,
aws_region,
compliance_type,
config_rule_invoked_time,
evaluation_result_identifier,
result_recorded_time
FROM aws.config.aggregate_compliance_details_by_config_rules
WHERE region = '{{ region }}' -- required
;