resourcegroupstaggingapi_get_compliance_summary: Returns a table that shows counts of resources that are...

Description Usage Arguments Value Request syntax

View source: R/resourcegroupstaggingapi_operations.R

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 AWS Organizations User Guide.

You can call this operation only from the organization's master account and from the us-east-1 Region.

Usage

1
2
3
resourcegroupstaggingapi_get_compliance_summary(TargetIdFilters,
  RegionFilters, ResourceTypeFilters, TagKeyFilters, GroupBy, MaxResults,
  PaginationToken)

Arguments

TargetIdFilters

The 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

A list of Regions to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.

ResourceTypeFilters

The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2: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 AWS General Reference for the following:

You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

TagKeyFilters

A list of tag keys to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.

GroupBy

A list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

MaxResults

A limit that restricts the number of results that are returned per page.

PaginationToken

A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
list(
  SummaryList = list(
    list(
      LastUpdated = "string",
      TargetId = "string",
      TargetIdType = "ACCOUNT"|"OU"|"ROOT",
      Region = "string",
      ResourceType = "string",
      NonCompliantResources = 123
    )
  ),
  PaginationToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
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"
)

paws.management documentation built on March 8, 2021, 1:07 a.m.