@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetResourcesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
GetResourcesRequest() |
| 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()
Specifies a
PaginationToken response value from a previous request to indicate that you want the
next page of results. |
List<String> |
getResourceARNList()
Specifies a list of ARNs of resources for which you want to retrieve tag data.
|
Integer |
getResourcesPerPage()
Specifies the maximum number of results to be returned in each page.
|
List<String> |
getResourceTypeFilters()
Specifies the resource types that you want included in the response.
|
List<TagFilter> |
getTagFilters()
Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags
with the specified keys and, if included, the specified values.
|
Integer |
getTagsPerPage()
Amazon Web Services 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)
Specifies a
PaginationToken response value from a previous request to indicate that you want the
next page of results. |
void |
setResourceARNList(Collection<String> resourceARNList)
Specifies a list of ARNs of resources for which you want to retrieve tag data.
|
void |
setResourcesPerPage(Integer resourcesPerPage)
Specifies the maximum number of results to be returned in each page.
|
void |
setResourceTypeFilters(Collection<String> resourceTypeFilters)
Specifies the resource types that you want included in the response.
|
void |
setTagFilters(Collection<TagFilter> tagFilters)
Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags
with the specified keys and, if included, the specified values.
|
void |
setTagsPerPage(Integer tagsPerPage)
Amazon Web Services 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)
Specifies a
PaginationToken response value from a previous request to indicate that you want the
next page of results. |
GetResourcesRequest |
withResourceARNList(Collection<String> resourceARNList)
Specifies a list of ARNs of resources for which you want to retrieve tag data.
|
GetResourcesRequest |
withResourceARNList(String... resourceARNList)
Specifies a list of ARNs of resources for which you want to retrieve tag data.
|
GetResourcesRequest |
withResourcesPerPage(Integer resourcesPerPage)
Specifies the maximum number of results to be returned in each page.
|
GetResourcesRequest |
withResourceTypeFilters(Collection<String> resourceTypeFilters)
Specifies the resource types that you want included in the response.
|
GetResourcesRequest |
withResourceTypeFilters(String... resourceTypeFilters)
Specifies the resource types that you want included in the response.
|
GetResourcesRequest |
withTagFilters(Collection<TagFilter> tagFilters)
Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags
with the specified keys and, if included, the specified values.
|
GetResourcesRequest |
withTagFilters(TagFilter... tagFilters)
Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags
with the specified keys and, if included, the specified values.
|
GetResourcesRequest |
withTagsPerPage(Integer tagsPerPage)
Amazon Web Services recommends using
ResourcesPerPage instead of this parameter. |
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, withSdkRequestTimeoutpublic 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.
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.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.
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.public GetResourcesRequest 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.
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.public List<TagFilter> getTagFilters()
Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags
with the specified keys and, if included, the specified values. Each TagFilter must contain a key
with values 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 don't specify a TagFilter, the response includes all resources that are currently
tagged or ever had a tag. Resources that currently don't have 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 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 a value for a key, the response returns all resources that are tagged with that key, with any or no value.
For example, for the following filters: filter1= {keyA,{value1}},
filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:
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 with the key key3, and
with any or no value
GetResources({filter1,filter2,filter3}) returns resources tagged with
(key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
TagFilter must
contain a key with values 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 don't specify a TagFilter, the response includes all resources that are
currently tagged or ever had a tag. Resources that currently don't have 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 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 a value for a key, the response returns all resources that are tagged with that key, with any or no value.
For example, for the following filters: filter1= {keyA,{value1}},
filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:
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 with the key key3
, and with any or no value
GetResources({filter1,filter2,filter3}) returns resources tagged with
(key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
public void setTagFilters(Collection<TagFilter> tagFilters)
Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags
with the specified keys and, if included, the specified values. Each TagFilter must contain a key
with values 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 don't specify a TagFilter, the response includes all resources that are currently
tagged or ever had a tag. Resources that currently don't have 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 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 a value for a key, the response returns all resources that are tagged with that key, with any or no value.
For example, for the following filters: filter1= {keyA,{value1}},
filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:
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 with the key key3, and
with any or no value
GetResources({filter1,filter2,filter3}) returns resources tagged with
(key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
tagFilters - Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have
tags with the specified keys and, if included, the specified values. Each TagFilter must
contain a key with values 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 don't specify a TagFilter, the response includes all resources that are
currently tagged or ever had a tag. Resources that currently don't have 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 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 a value for a key, the response returns all resources that are tagged with that key, with any or no value.
For example, for the following filters: filter1= {keyA,{value1}},
filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:
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 with the key key3,
and with any or no value
GetResources({filter1,filter2,filter3}) returns resources tagged with
(key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
public GetResourcesRequest withTagFilters(TagFilter... tagFilters)
Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags
with the specified keys and, if included, the specified values. Each TagFilter must contain a key
with values 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 don't specify a TagFilter, the response includes all resources that are currently
tagged or ever had a tag. Resources that currently don't have 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 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 a value for a key, the response returns all resources that are tagged with that key, with any or no value.
For example, for the following filters: filter1= {keyA,{value1}},
filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:
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 with the key key3, and
with any or no value
GetResources({filter1,filter2,filter3}) returns resources tagged with
(key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no 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.
tagFilters - Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have
tags with the specified keys and, if included, the specified values. Each TagFilter must
contain a key with values 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 don't specify a TagFilter, the response includes all resources that are
currently tagged or ever had a tag. Resources that currently don't have 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 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 a value for a key, the response returns all resources that are tagged with that key, with any or no value.
For example, for the following filters: filter1= {keyA,{value1}},
filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:
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 with the key key3,
and with any or no value
GetResources({filter1,filter2,filter3}) returns resources tagged with
(key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
public GetResourcesRequest withTagFilters(Collection<TagFilter> tagFilters)
Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags
with the specified keys and, if included, the specified values. Each TagFilter must contain a key
with values 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 don't specify a TagFilter, the response includes all resources that are currently
tagged or ever had a tag. Resources that currently don't have 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 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 a value for a key, the response returns all resources that are tagged with that key, with any or no value.
For example, for the following filters: filter1= {keyA,{value1}},
filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:
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 with the key key3, and
with any or no value
GetResources({filter1,filter2,filter3}) returns resources tagged with
(key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
tagFilters - Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have
tags with the specified keys and, if included, the specified values. Each TagFilter must
contain a key with values 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 don't specify a TagFilter, the response includes all resources that are
currently tagged or ever had a tag. Resources that currently don't have 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 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 a value for a key, the response returns all resources that are tagged with that key, with any or no value.
For example, for the following filters: filter1= {keyA,{value1}},
filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:
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 with the key key3,
and with any or no value
GetResources({filter1,filter2,filter3}) returns resources tagged with
(key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
public void setResourcesPerPage(Integer resourcesPerPage)
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.
resourcesPerPage - 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.public Integer getResourcesPerPage()
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.
PaginationToken response value to see if there are more results. You can specify a minimum
of 1 and a maximum value of 100.public GetResourcesRequest withResourcesPerPage(Integer resourcesPerPage)
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.
resourcesPerPage - 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.public void setTagsPerPage(Integer tagsPerPage)
Amazon Web Services 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 up to a maximum of 500 items.
tagsPerPage - Amazon Web Services 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 up to a maximum of 500 items.
public Integer getTagsPerPage()
Amazon Web Services 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 up to a maximum of 500 items.
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 up to a maximum of 500 items.
public GetResourcesRequest withTagsPerPage(Integer tagsPerPage)
Amazon Web Services 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 up to a maximum of 500 items.
tagsPerPage - Amazon Web Services 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 up to a maximum of 500 items.
public List<String> getResourceTypeFilters()
Specifies the resource types that you want included in the response. 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.
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. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:
ec2:instance,s3:bucket,auditmanager
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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.
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. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:
ec2:instance,s3:bucket,auditmanager
public void setResourceTypeFilters(Collection<String> resourceTypeFilters)
Specifies the resource types that you want included in the response. 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.
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. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:
ec2:instance,s3:bucket,auditmanager
resourceTypeFilters - Specifies the resource types that you want included in the response. 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.
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. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:
ec2:instance,s3:bucket,auditmanager
public GetResourcesRequest withResourceTypeFilters(String... resourceTypeFilters)
Specifies the resource types that you want included in the response. 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.
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. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:
ec2:instance,s3:bucket,auditmanager
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.
resourceTypeFilters - Specifies the resource types that you want included in the response. 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.
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. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:
ec2:instance,s3:bucket,auditmanager
public GetResourcesRequest withResourceTypeFilters(Collection<String> resourceTypeFilters)
Specifies the resource types that you want included in the response. 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.
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. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:
ec2:instance,s3:bucket,auditmanager
resourceTypeFilters - Specifies the resource types that you want included in the response. 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.
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. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:
ec2:instance,s3:bucket,auditmanager
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.
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.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.
true to determine whether resources are compliant with the tag policy and to get details.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.
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.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.
true to determine whether resources are compliant with the tag policy and to get details.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.
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.
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.
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.
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.
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.
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.
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.
public List<String> getResourceARNList()
Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this
parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage,
PaginationToken) in the same request. If you specify both, you get an Invalid Parameter
exception.
If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.
An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
ResourcesPerPage,
TagsPerPage, PaginationToken) in the same request. If you specify both, you get
an Invalid Parameter exception.
If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.
An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
public void setResourceARNList(Collection<String> resourceARNList)
Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this
parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage,
PaginationToken) in the same request. If you specify both, you get an Invalid Parameter
exception.
If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.
An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
resourceARNList - Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this
parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage,
PaginationToken) in the same request. If you specify both, you get an
Invalid Parameter exception.
If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.
An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
public GetResourcesRequest withResourceARNList(String... resourceARNList)
Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this
parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage,
PaginationToken) in the same request. If you specify both, you get an Invalid Parameter
exception.
If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.
An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
NOTE: This method appends the values to the existing list (if any). Use
setResourceARNList(java.util.Collection) or withResourceARNList(java.util.Collection) if you
want to override the existing values.
resourceARNList - Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this
parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage,
PaginationToken) in the same request. If you specify both, you get an
Invalid Parameter exception.
If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.
An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
public GetResourcesRequest withResourceARNList(Collection<String> resourceARNList)
Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this
parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage,
PaginationToken) in the same request. If you specify both, you get an Invalid Parameter
exception.
If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.
An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
resourceARNList - Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this
parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage,
PaginationToken) in the same request. If you specify both, you get an
Invalid Parameter exception.
If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.
An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
public String toString()
toString in class ObjectObject.toString()public GetResourcesRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()