compliance_summaries

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

Overview

Name	compliance_summaries
Type	Resource
Id	aws.resourcegroupstaggingapi.compliance_summaries

Fields

The following fields are returned by SELECT queries:

get_compliance_summary

Name	Datatype	Description
last_updated	string	The timestamp that shows when this summary was generated in this Region.
non_compliant_resources	integer (int64)	The count of noncompliant resources.
region	string	The Amazon Web Services Region that the summary applies to. (pattern: <code>[\s\S]*</code>)
resource_type	string	The Amazon Web Services resource type. (pattern: <code>[\s\S]*</code>)
target_id	string	The account identifier or the root identifier of the organization. If you don't know the root ID, you can call the Organizations ListRoots API. (pattern: <code>[a-zA-Z0-9-]*</code>)
target_id_type	string	Whether the target is an account, an OU, or the organization root. (ACCOUNT, OU, ROOT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_compliance_summary	select	region		Returns a table that shows counts of resources that are noncompliant with their tag policies. For more information on tag policies, see Tag Policies in the Organizations User Guide. You can call this operation only from the organization's management account and from the us-east-1 Region. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

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_compliance_summary

Returns a table that shows counts of resources that are noncompliant with their tag policies. For more information on tag policies, see Tag Policies in the Organizations User Guide. You can call this operation only from the organization's management account and from the us-east-1 Region. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

SELECT
last_updated,
non_compliant_resources,
region,
resource_type,
target_id,
target_id_type
FROM aws.resourcegroupstaggingapi.compliance_summaries
WHERE region = '{{ region }}' -- required
;