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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb

Overview

Note:

When making an API call, you may pass GetComplianceSummaryInput data as a 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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#group_byArray<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>)


268
269
270
271
272
273
274
275
276
277
278
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 268

class GetComplianceSummaryInput < Struct.new(
  :target_id_filters,
  :region_filters,
  :resource_type_filters,
  :tag_key_filters,
  :group_by,
  :max_results,
  :pagination_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


268
269
270
271
272
273
274
275
276
277
278
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 268

class GetComplianceSummaryInput < Struct.new(
  :target_id_filters,
  :region_filters,
  :resource_type_filters,
  :tag_key_filters,
  :group_by,
  :max_results,
  :pagination_token)
  SENSITIVE = []
  include Aws::Structure
end

#pagination_tokenString

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)


268
269
270
271
272
273
274
275
276
277
278
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 268

class GetComplianceSummaryInput < Struct.new(
  :target_id_filters,
  :region_filters,
  :resource_type_filters,
  :tag_key_filters,
  :group_by,
  :max_results,
  :pagination_token)
  SENSITIVE = []
  include Aws::Structure
end

#region_filtersArray<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>)


268
269
270
271
272
273
274
275
276
277
278
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 268

class GetComplianceSummaryInput < Struct.new(
  :target_id_filters,
  :region_filters,
  :resource_type_filters,
  :tag_key_filters,
  :group_by,
  :max_results,
  :pagination_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type_filtersArray<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>)


268
269
270
271
272
273
274
275
276
277
278
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 268

class GetComplianceSummaryInput < Struct.new(
  :target_id_filters,
  :region_filters,
  :resource_type_filters,
  :tag_key_filters,
  :group_by,
  :max_results,
  :pagination_token)
  SENSITIVE = []
  include Aws::Structure
end

#tag_key_filtersArray<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>)


268
269
270
271
272
273
274
275
276
277
278
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 268

class GetComplianceSummaryInput < Struct.new(
  :target_id_filters,
  :region_filters,
  :resource_type_filters,
  :tag_key_filters,
  :group_by,
  :max_results,
  :pagination_token)
  SENSITIVE = []
  include Aws::Structure
end

#target_id_filtersArray<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>)


268
269
270
271
272
273
274
275
276
277
278
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 268

class GetComplianceSummaryInput < Struct.new(
  :target_id_filters,
  :region_filters,
  :resource_type_filters,
  :tag_key_filters,
  :group_by,
  :max_results,
  :pagination_token)
  SENSITIVE = []
  include Aws::Structure
end