/AWS1/CL_RGS=>GETCOMPLIANCESUMMARY()
¶
About GetComplianceSummary¶
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.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IT_TARGETIDFILTERS
TYPE /AWS1/CL_RGSTGTIDFILTERLIST_W=>TT_TARGETIDFILTERLIST
TT_TARGETIDFILTERLIST
¶
Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.
IT_REGIONFILTERS
TYPE /AWS1/CL_RGSREGIONFILTERLIST_W=>TT_REGIONFILTERLIST
TT_REGIONFILTERLIST
¶
Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
IT_RESOURCETYPEFILTERS
TYPE /AWS1/CL_RGSRESRCTYPEFILTLST_W=>TT_RESOURCETYPEFILTERLIST
TT_RESOURCETYPEFILTERLIST
¶
Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is
service[:resourceType]
. For example, specifying a resource type ofec2
returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type ofec2:instance
returns only EC2 instances.The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the Amazon Web Services General Reference for the following:
For a list of service name strings, see Amazon Web Services Service Namespaces.
For resource type strings, see Example ARNs.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.
IT_TAGKEYFILTERS
TYPE /AWS1/CL_RGSTAGKEYFILTERLIST_W=>TT_TAGKEYFILTERLIST
TT_TAGKEYFILTERLIST
¶
Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
IT_GROUPBY
TYPE /AWS1/CL_RGSGROUPBY_W=>TT_GROUPBY
TT_GROUPBY
¶
Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
IV_MAXRESULTS
TYPE /AWS1/RGSMAXRSLTSGETCPLNCSUMM
/AWS1/RGSMAXRSLTSGETCPLNCSUMM
¶
Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the
PaginationToken
response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.
IV_PAGINATIONTOKEN
TYPE /AWS1/RGSPAGINATIONTOKEN
/AWS1/RGSPAGINATIONTOKEN
¶
Specifies a
PaginationToken
response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.