Class: Aws::ResourceGroupsTaggingAPI::Types::GetComplianceSummaryInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::ResourceGroupsTaggingAPI::Types::GetComplianceSummaryInput
- Defined in:
- gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#group_by ⇒ Array<String>
Specifies a list of attributes to group the counts of noncompliant resources by.
-
#max_results ⇒ Integer
Specifies the maximum number of results to be returned in each page.
-
#pagination_token ⇒ String
Specifies a
PaginationToken
response value from a previous request to indicate that you want the next page of results. -
#region_filters ⇒ Array<String>
Specifies a list of Amazon Web Services Regions to limit the output to.
-
#resource_type_filters ⇒ Array<String>
Specifies that you want the response to include information for only resources of the specified types.
-
#tag_key_filters ⇒ Array<String>
Specifies that you want the response to include information for only resources that have tags with the specified tag keys.
-
#target_id_filters ⇒ Array<String>
Specifies target identifiers (usually, specific account IDs) to limit the output by.
Instance Attribute Details
#group_by ⇒ Array<String>
Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
262 263 264 265 266 267 268 269 270 271 272 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 262 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_results ⇒ Integer
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.
262 263 264 265 266 267 268 269 270 271 272 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 262 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_token ⇒ String
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.
262 263 264 265 266 267 268 269 270 271 272 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 262 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_filters ⇒ Array<String>
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.
262 263 264 265 266 267 268 269 270 271 272 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 262 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_filters ⇒ Array<String>
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
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 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.
262 263 264 265 266 267 268 269 270 271 272 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 262 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_filters ⇒ Array<String>
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.
262 263 264 265 266 267 268 269 270 271 272 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 262 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_filters ⇒ Array<String>
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.
262 263 264 265 266 267 268 269 270 271 272 |
# File 'gems/aws-sdk-resourcegroupstaggingapi/lib/aws-sdk-resourcegroupstaggingapi/types.rb', line 262 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 |