com.amazonaws.services.resourcegroupstaggingapi.model

Class GetComplianceSummaryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.resourcegroupstaggingapi.model.GetComplianceSummaryRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetComplianceSummaryRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetComplianceSummaryRequest()

Method Summary

Modifier and Type	Method and Description
GetComplianceSummaryRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getGroupBy() Specifies a list of attributes to group the counts of noncompliant resources by.
Integer	getMaxResults() Specifies the maximum number of results to be returned in each page.
String	getPaginationToken() Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results.
List<String>	getRegionFilters() Specifies a list of Amazon Web Services Regions to limit the output to.
List<String>	getResourceTypeFilters() Specifies that you want the response to include information for only resources of the specified types.
List<String>	getTagKeyFilters() Specifies that you want the response to include information for only resources that have tags with the specified tag keys.
List<String>	getTargetIdFilters() Specifies target identifiers (usually, specific account IDs) to limit the output by.
int	hashCode()
void	setGroupBy(Collection<String> groupBy) Specifies a list of attributes to group the counts of noncompliant resources by.
void	setMaxResults(Integer maxResults) Specifies the maximum number of results to be returned in each page.
void	setPaginationToken(String paginationToken) Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results.
void	setRegionFilters(Collection<String> regionFilters) Specifies a list of Amazon Web Services Regions to limit the output to.
void	setResourceTypeFilters(Collection<String> resourceTypeFilters) Specifies that you want the response to include information for only resources of the specified types.
void	setTagKeyFilters(Collection<String> tagKeyFilters) Specifies that you want the response to include information for only resources that have tags with the specified tag keys.
void	setTargetIdFilters(Collection<String> targetIdFilters) Specifies target identifiers (usually, specific account IDs) to limit the output by.
String	toString() Returns a string representation of this object.
GetComplianceSummaryRequest	withGroupBy(Collection<String> groupBy) Specifies a list of attributes to group the counts of noncompliant resources by.
GetComplianceSummaryRequest	withGroupBy(GroupByAttribute... groupBy) Specifies a list of attributes to group the counts of noncompliant resources by.
GetComplianceSummaryRequest	withGroupBy(String... groupBy) Specifies a list of attributes to group the counts of noncompliant resources by.
GetComplianceSummaryRequest	withMaxResults(Integer maxResults) Specifies the maximum number of results to be returned in each page.
GetComplianceSummaryRequest	withPaginationToken(String paginationToken) Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results.
GetComplianceSummaryRequest	withRegionFilters(Collection<String> regionFilters) Specifies a list of Amazon Web Services Regions to limit the output to.
GetComplianceSummaryRequest	withRegionFilters(String... regionFilters) Specifies a list of Amazon Web Services Regions to limit the output to.
GetComplianceSummaryRequest	withResourceTypeFilters(Collection<String> resourceTypeFilters) Specifies that you want the response to include information for only resources of the specified types.
GetComplianceSummaryRequest	withResourceTypeFilters(String... resourceTypeFilters) Specifies that you want the response to include information for only resources of the specified types.
GetComplianceSummaryRequest	withTagKeyFilters(Collection<String> tagKeyFilters) Specifies that you want the response to include information for only resources that have tags with the specified tag keys.
GetComplianceSummaryRequest	withTagKeyFilters(String... tagKeyFilters) Specifies that you want the response to include information for only resources that have tags with the specified tag keys.
GetComplianceSummaryRequest	withTargetIdFilters(Collection<String> targetIdFilters) Specifies target identifiers (usually, specific account IDs) to limit the output by.
GetComplianceSummaryRequest	withTargetIdFilters(String... targetIdFilters) Specifies target identifiers (usually, specific account IDs) to limit the output by.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetComplianceSummaryRequest

public GetComplianceSummaryRequest()

Method Detail

getTargetIdFilters

public List<String> getTargetIdFilters()

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.

Returns:

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.

setTargetIdFilters

public void setTargetIdFilters(Collection<String> 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.

Parameters:

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.

withTargetIdFilters

public GetComplianceSummaryRequest withTargetIdFilters(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setTargetIdFilters(java.util.Collection) or withTargetIdFilters(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTargetIdFilters

public GetComplianceSummaryRequest withTargetIdFilters(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getRegionFilters

public List<String> getRegionFilters()

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.

Returns:

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.

setRegionFilters

public void setRegionFilters(Collection<String> 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.

Parameters:

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.

withRegionFilters

public GetComplianceSummaryRequest withRegionFilters(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setRegionFilters(java.util.Collection) or withRegionFilters(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withRegionFilters

public GetComplianceSummaryRequest withRegionFilters(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getResourceTypeFilters

public List<String> getResourceTypeFilters()

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.

Returns:

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.

setResourceTypeFilters

public void setResourceTypeFilters(Collection<String> resourceTypeFilters)

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.

Parameters:

resourceTypeFilters - 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.

withResourceTypeFilters

public GetComplianceSummaryRequest withResourceTypeFilters(String... resourceTypeFilters)

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.

NOTE: This method appends the values to the existing list (if any). Use setResourceTypeFilters(java.util.Collection) or withResourceTypeFilters(java.util.Collection) if you want to override the existing values.

Parameters:

resourceTypeFilters - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withResourceTypeFilters

public GetComplianceSummaryRequest withResourceTypeFilters(Collection<String> resourceTypeFilters)

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.

Parameters:

resourceTypeFilters - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTagKeyFilters

public List<String> getTagKeyFilters()

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.

Returns:

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.

setTagKeyFilters

public void setTagKeyFilters(Collection<String> 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.

Parameters:

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.

withTagKeyFilters

public GetComplianceSummaryRequest withTagKeyFilters(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setTagKeyFilters(java.util.Collection) or withTagKeyFilters(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTagKeyFilters

public GetComplianceSummaryRequest withTagKeyFilters(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getGroupBy

public List<String> getGroupBy()

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

Returns:

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

See Also:

GroupByAttribute

setGroupBy

public void setGroupBy(Collection<String> groupBy)

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

Parameters:

groupBy - Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

See Also:

GroupByAttribute

withGroupBy

public GetComplianceSummaryRequest withGroupBy(String... groupBy)

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

NOTE: This method appends the values to the existing list (if any). Use setGroupBy(java.util.Collection) or withGroupBy(java.util.Collection) if you want to override the existing values.

Parameters:

groupBy - Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GroupByAttribute

withGroupBy

public GetComplianceSummaryRequest withGroupBy(Collection<String> groupBy)

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

Parameters:

groupBy - Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GroupByAttribute

withGroupBy

public GetComplianceSummaryRequest withGroupBy(GroupByAttribute... groupBy)

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

Parameters:

groupBy - Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GroupByAttribute

setMaxResults

public void setMaxResults(Integer 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 response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

Parameters:

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 response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

getMaxResults

public Integer getMaxResults()

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.

Returns:

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.

withMaxResults

public GetComplianceSummaryRequest withMaxResults(Integer 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 response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

Parameters:

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 response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPaginationToken

public void setPaginationToken(String paginationToken)

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.

Parameters:

paginationToken - 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.

getPaginationToken

public String getPaginationToken()

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.

Returns:

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.

withPaginationToken

public GetComplianceSummaryRequest withPaginationToken(String paginationToken)

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.

Parameters:

paginationToken - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetComplianceSummaryRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()