resource_compliance_summaries

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

Overview

Name	resource_compliance_summaries
Type	Resource
Id	aws.ssm.resource_compliance_summaries

Fields

The following fields are returned by SELECT queries:

list_resource_compliance_summaries

Name	Datatype	Description
compliance_type	string	The compliance type. (pattern: <code>[A-Za-z0-9_-]\w+|Custom:[a-zA-Z0-9_-]\w+</code>)
compliant_summary	object	A list of items that are compliant for the resource.
execution_summary	object	Information about the execution.
non_compliant_summary	object	A list of items that aren't compliant for the resource.
overall_severity	string	The highest severity item found for the resource. The resource is compliant for this item. (CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED)
resource_id	string	The resource ID.
resource_type	string	The resource type.
status	string	The compliance status for the resource. (COMPLIANT, NON_COMPLIANT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_resource_compliance_summaries	select	region		Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

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

list_resource_compliance_summaries

Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

SELECT
compliance_type,
compliant_summary,
execution_summary,
non_compliant_summary,
overall_severity,
resource_id,
resource_type,
status
FROM aws.ssm.resource_compliance_summaries
WHERE region = '{{ region }}' -- required
;