com.amazonaws.services.resourcegroupstaggingapi.model

Class GetResourcesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.resourcegroupstaggingapi.model.GetResourcesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetResourcesRequest
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
GetResourcesRequest()

Method Summary

Modifier and Type	Method and Description
GetResourcesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getExcludeCompliantResources() Specifies whether to exclude resources that are compliant with the tag policy.
Boolean	getIncludeComplianceDetails() Specifies whether to include details regarding the compliance with the effective tag policy.
String	getPaginationToken() A string that indicates that additional data is available.
Integer	getResourcesPerPage() A limit that restricts the number of resources returned by GetResources in paginated output.
List<String>	getResourceTypeFilters() The constraints on the resources that you want returned.
List<TagFilter>	getTagFilters() A list of TagFilters (keys and values).
Integer	getTagsPerPage() AWS recommends using ResourcesPerPage instead of this parameter.
int	hashCode()
Boolean	isExcludeCompliantResources() Specifies whether to exclude resources that are compliant with the tag policy.
Boolean	isIncludeComplianceDetails() Specifies whether to include details regarding the compliance with the effective tag policy.
void	setExcludeCompliantResources(Boolean excludeCompliantResources) Specifies whether to exclude resources that are compliant with the tag policy.
void	setIncludeComplianceDetails(Boolean includeComplianceDetails) Specifies whether to include details regarding the compliance with the effective tag policy.
void	setPaginationToken(String paginationToken) A string that indicates that additional data is available.
void	setResourcesPerPage(Integer resourcesPerPage) A limit that restricts the number of resources returned by GetResources in paginated output.
void	setResourceTypeFilters(Collection<String> resourceTypeFilters) The constraints on the resources that you want returned.
void	setTagFilters(Collection<TagFilter> tagFilters) A list of TagFilters (keys and values).
void	setTagsPerPage(Integer tagsPerPage) AWS recommends using ResourcesPerPage instead of this parameter.
String	toString() Returns a string representation of this object.
GetResourcesRequest	withExcludeCompliantResources(Boolean excludeCompliantResources) Specifies whether to exclude resources that are compliant with the tag policy.
GetResourcesRequest	withIncludeComplianceDetails(Boolean includeComplianceDetails) Specifies whether to include details regarding the compliance with the effective tag policy.
GetResourcesRequest	withPaginationToken(String paginationToken) A string that indicates that additional data is available.
GetResourcesRequest	withResourcesPerPage(Integer resourcesPerPage) A limit that restricts the number of resources returned by GetResources in paginated output.
GetResourcesRequest	withResourceTypeFilters(Collection<String> resourceTypeFilters) The constraints on the resources that you want returned.
GetResourcesRequest	withResourceTypeFilters(String... resourceTypeFilters) The constraints on the resources that you want returned.
GetResourcesRequest	withTagFilters(Collection<TagFilter> tagFilters) A list of TagFilters (keys and values).
GetResourcesRequest	withTagFilters(TagFilter... tagFilters) A list of TagFilters (keys and values).
GetResourcesRequest	withTagsPerPage(Integer tagsPerPage) AWS recommends using ResourcesPerPage instead of this parameter.

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

GetResourcesRequest

public GetResourcesRequest()

Method Detail

setPaginationToken

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

Parameters:

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.

getPaginationToken

public String getPaginationToken()

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:

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.

withPaginationToken

public GetResourcesRequest withPaginationToken(String 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.

Parameters:

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.

Returns:

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

getTagFilters

public List<TagFilter> getTagFilters()

A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

• If you do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.

• If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: "Tags": [].

• If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters.

• If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

• If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value.

  For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:

  • GetResources( {filter1} ) returns resources tagged with key1=value1

  • GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4

  • GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value

  • GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)

Returns:

A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

• If you do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.

• If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: "Tags": [].

• If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters.

• If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

• If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value.

  For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:

  • GetResources( {filter1} ) returns resources tagged with key1=value1

  • GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4

  • GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value

  • GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)

setTagFilters

public void setTagFilters(Collection<TagFilter> tagFilters)

A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

• If you do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.

• If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: "Tags": [].

• If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters.

• If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

• If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value.

  For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:

  • GetResources( {filter1} ) returns resources tagged with key1=value1

  • GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4

  • GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value

  • GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)

Parameters:

tagFilters - A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

• If you do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.

• If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: "Tags": [].

• If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters.

• If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

• If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value.

  For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:

  • GetResources( {filter1} ) returns resources tagged with key1=value1

  • GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4

  • GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value

  • GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)

withTagFilters

public GetResourcesRequest withTagFilters(TagFilter... tagFilters)

A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

• If you do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.

• If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: "Tags": [].

• If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters.

• If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

• If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value.

  For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:

  • GetResources( {filter1} ) returns resources tagged with key1=value1

  • GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4

  • GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value

  • GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)

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

Parameters:

tagFilters - A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

• If you do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.

• If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: "Tags": [].

• If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters.

• If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

• If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value.

  For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:

  • GetResources( {filter1} ) returns resources tagged with key1=value1

  • GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4

  • GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value

  • GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)

Returns:

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

withTagFilters

public GetResourcesRequest withTagFilters(Collection<TagFilter> tagFilters)

A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

• If you do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.

• If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: "Tags": [].

• If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters.

• If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

• If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value.

  For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:

  • GetResources( {filter1} ) returns resources tagged with key1=value1

  • GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4

  • GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value

  • GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)

Parameters:

tagFilters - A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

• If you do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.

• If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: "Tags": [].

• If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters.

• If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

• If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value.

  For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:

  • GetResources( {filter1} ) returns resources tagged with key1=value1

  • GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4

  • GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value

  • GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)

Returns:

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

setResourcesPerPage

public void setResourcesPerPage(Integer resourcesPerPage)

A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100 items.

Parameters:

resourcesPerPage - A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100 items.

getResourcesPerPage

public Integer getResourcesPerPage()

A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100 items.

Returns:

A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100 items.

withResourcesPerPage

public GetResourcesRequest withResourcesPerPage(Integer resourcesPerPage)

A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100 items.

Parameters:

resourcesPerPage - A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100 items.

Returns:

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

setTagsPerPage

public void setTagsPerPage(Integer tagsPerPage)

AWS recommends using ResourcesPerPage instead of this parameter.

A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

Parameters:

tagsPerPage - AWS recommends using ResourcesPerPage instead of this parameter.

A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

getTagsPerPage

public Integer getTagsPerPage()

AWS recommends using ResourcesPerPage instead of this parameter.

A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

Returns:

AWS recommends using ResourcesPerPage instead of this parameter.

A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

withTagsPerPage

public GetResourcesRequest withTagsPerPage(Integer tagsPerPage)

AWS recommends using ResourcesPerPage instead of this parameter.

A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

Parameters:

tagsPerPage - AWS recommends using ResourcesPerPage instead of this parameter.

A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

Returns:

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

getResourceTypeFilters

public List<String> getResourceTypeFilters()

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:

• For a list of service name strings, see AWS Service Namespaces.

• For resource type strings, see Example ARNs.

• For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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:

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:

• For a list of service name strings, see AWS Service Namespaces.

• For resource type strings, see Example ARNs.

• For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

setResourceTypeFilters

public void setResourceTypeFilters(Collection<String> 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:

• For a list of service name strings, see AWS Service Namespaces.

• For resource type strings, see Example ARNs.

• For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

Parameters:

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:

• For a list of service name strings, see AWS Service Namespaces.

• For resource type strings, see Example ARNs.

• For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

withResourceTypeFilters

public GetResourcesRequest withResourceTypeFilters(String... 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:

• For a list of service name strings, see AWS Service Namespaces.

• For resource type strings, see Example ARNs.

• For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

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 - 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:

• For a list of service name strings, see AWS Service Namespaces.

• For resource type strings, see Example ARNs.

• For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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:

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

withResourceTypeFilters

public GetResourcesRequest withResourceTypeFilters(Collection<String> 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:

• For a list of service name strings, see AWS Service Namespaces.

• For resource type strings, see Example ARNs.

• For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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.

Parameters:

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:

• For a list of service name strings, see AWS Service Namespaces.

• For resource type strings, see Example ARNs.

• For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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:

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

setIncludeComplianceDetails

public void setIncludeComplianceDetails(Boolean includeComplianceDetails)

Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

Parameters:

includeComplianceDetails - Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

getIncludeComplianceDetails

public Boolean getIncludeComplianceDetails()

Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

Returns:

Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

withIncludeComplianceDetails

public GetResourcesRequest withIncludeComplianceDetails(Boolean includeComplianceDetails)

Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

Parameters:

includeComplianceDetails - Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

Returns:

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

isIncludeComplianceDetails

public Boolean isIncludeComplianceDetails()

Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

Returns:

Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

setExcludeCompliantResources

public void setExcludeCompliantResources(Boolean excludeCompliantResources)

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

Parameters:

excludeCompliantResources - Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

getExcludeCompliantResources

public Boolean getExcludeCompliantResources()

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

Returns:

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

withExcludeCompliantResources

public GetResourcesRequest withExcludeCompliantResources(Boolean excludeCompliantResources)

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

Parameters:

excludeCompliantResources - Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

Returns:

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

isExcludeCompliantResources

public Boolean isExcludeCompliantResources()

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

Returns:

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

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 GetResourcesRequest 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()