compliance_summaries

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

Overview

Name	compliance_summaries
Type	Resource
Id	aws.ssm.compliance_summaries

Fields

The following fields are returned by SELECT queries:

list_compliance_summaries

Name	Datatype	Description
compliance_type	string	The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string. (pattern: <code>[A-Za-z0-9_-]\w+|Custom:[a-zA-Z0-9_-]\w+</code>)
compliant_summary	object	A list of COMPLIANT items for the specified compliance type.
non_compliant_summary	object	A list of NON_COMPLIANT items for the specified compliance type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_compliance_summaries	select	region		Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that 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_compliance_summaries

Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

SELECT
compliance_type,
compliant_summary,
non_compliant_summary
FROM aws.ssm.compliance_summaries
WHERE region = '{{ region }}' -- required
;