You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ResourceGroupsTaggingAPI::Types::GetComplianceSummaryInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetComplianceSummaryInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  target_id_filters: ["TargetId"],
  region_filters: ["Region"],
  resource_type_filters: ["AmazonResourceType"],
  tag_key_filters: ["TagKey"],
  group_by: ["TARGET_ID"], # accepts TARGET_ID, REGION, RESOURCE_TYPE
  max_results: 1,
  pagination_token: "PaginationToken",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#group_by ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    A list of attributes to group the counts of noncompliant resources by.

#max_results ⇒ Integer

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

Returns:

  • (Integer) —

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

#pagination_token ⇒ String

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.

Returns:

  • (String) —

    A string that indicates that additional data is available.

#region_filters ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    A list of Regions to limit the output by.

#resource_type_filters ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    The constraints on the resources that you want returned.

#tag_key_filters ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    A list of tag keys to limit the output by.

#target_id_filters ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    The target identifiers (usually, specific account IDs) to limit the output by.