Get Compliance Summary
resourcegroupstaggingapi_get_compliance_summary | R Documentation |
Returns a table that shows counts of resources that are noncompliant with their tag policies¶
Description¶
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.
Usage¶
resourcegroupstaggingapi_get_compliance_summary(TargetIdFilters,
RegionFilters, ResourceTypeFilters, TagKeyFilters, GroupBy, MaxResults,
PaginationToken)
Arguments¶
TargetIdFilters |
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. |
RegionFilters |
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. |
ResourceTypeFilters |
Specifies that you want the response to include information for
only resources of the specified types. The format of each resource type
is 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:
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. |
TagKeyFilters |
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. |
GroupBy |
Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes. |
MaxResults |
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 |
Specifies a |
Value¶
A list with the following syntax:
list(
SummaryList = list(
list(
LastUpdated = "string",
TargetId = "string",
TargetIdType = "ACCOUNT"|"OU"|"ROOT",
Region = "string",
ResourceType = "string",
NonCompliantResources = 123
)
),
PaginationToken = "string"
)
Request syntax¶
svc$get_compliance_summary(
TargetIdFilters = list(
"string"
),
RegionFilters = list(
"string"
),
ResourceTypeFilters = list(
"string"
),
TagKeyFilters = list(
"string"
),
GroupBy = list(
"TARGET_ID"|"REGION"|"RESOURCE_TYPE"
),
MaxResults = 123,
PaginationToken = "string"
)