Interface ListGroupResourcesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListGroupResourcesRequest.Builder,
,ListGroupResourcesRequest> ResourceGroupsRequest.Builder
,SdkBuilder<ListGroupResourcesRequest.Builder,
,ListGroupResourcesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListGroupResourcesRequest
-
Method Summary
Modifier and TypeMethodDescriptionfilters
(Collection<ResourceFilter> filters) Filters, formatted as ResourceFilter objects, that you want to apply to aListGroupResources
operation.filters
(Consumer<ResourceFilter.Builder>... filters) Filters, formatted as ResourceFilter objects, that you want to apply to aListGroupResources
operation.filters
(ResourceFilter... filters) Filters, formatted as ResourceFilter objects, that you want to apply to aListGroupResources
operation.The name or the ARN of the resource groupDeprecated.This field is deprecated, use Group instead.maxResults
(Integer maxResults) The total number of results that you want included on each page of the response.The parameter for receiving additional results if you receive aNextToken
response in a previous request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.resourcegroups.model.ResourceGroupsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
groupName
Deprecated.This field is deprecated, use Group instead.Deprecated - don't use this parameter. Use the
Group
request field instead.- Parameters:
groupName
-Deprecated - don't use this parameter. Use the
Group
request field instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
group
The name or the ARN of the resource group
- Parameters:
group
- The name or the ARN of the resource group- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
Filters, formatted as ResourceFilter objects, that you want to apply to a
ListGroupResources
operation. Filters the results to include only those of the specified resource types.-
resource-type
- Filter resources by their type. Specify up to five resource types in the formatAWS::ServiceCode::ResourceType
. For example,AWS::EC2::Instance
, orAWS::S3::Bucket
.
When you specify a
resource-type
filter forListGroupResources
, Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but yourresource-type
filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, aListGroupResources
request returns aBadRequestException
error with a message similar to the following:The resource types specified as filters in the request are not valid.
The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies
AWS::AllSupported
, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or Amazon CloudFront stack-based queries).- Parameters:
filters
- Filters, formatted as ResourceFilter objects, that you want to apply to aListGroupResources
operation. Filters the results to include only those of the specified resource types.-
resource-type
- Filter resources by their type. Specify up to five resource types in the formatAWS::ServiceCode::ResourceType
. For example,AWS::EC2::Instance
, orAWS::S3::Bucket
.
When you specify a
resource-type
filter forListGroupResources
, Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but yourresource-type
filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, aListGroupResources
request returns aBadRequestException
error with a message similar to the following:The resource types specified as filters in the request are not valid.
The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies
AWS::AllSupported
, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or Amazon CloudFront stack-based queries).-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
Filters, formatted as ResourceFilter objects, that you want to apply to a
ListGroupResources
operation. Filters the results to include only those of the specified resource types.-
resource-type
- Filter resources by their type. Specify up to five resource types in the formatAWS::ServiceCode::ResourceType
. For example,AWS::EC2::Instance
, orAWS::S3::Bucket
.
When you specify a
resource-type
filter forListGroupResources
, Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but yourresource-type
filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, aListGroupResources
request returns aBadRequestException
error with a message similar to the following:The resource types specified as filters in the request are not valid.
The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies
AWS::AllSupported
, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or Amazon CloudFront stack-based queries).- Parameters:
filters
- Filters, formatted as ResourceFilter objects, that you want to apply to aListGroupResources
operation. Filters the results to include only those of the specified resource types.-
resource-type
- Filter resources by their type. Specify up to five resource types in the formatAWS::ServiceCode::ResourceType
. For example,AWS::EC2::Instance
, orAWS::S3::Bucket
.
When you specify a
resource-type
filter forListGroupResources
, Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but yourresource-type
filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, aListGroupResources
request returns aBadRequestException
error with a message similar to the following:The resource types specified as filters in the request are not valid.
The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies
AWS::AllSupported
, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or Amazon CloudFront stack-based queries).-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
Filters, formatted as ResourceFilter objects, that you want to apply to a
ListGroupResources
operation. Filters the results to include only those of the specified resource types.-
resource-type
- Filter resources by their type. Specify up to five resource types in the formatAWS::ServiceCode::ResourceType
. For example,AWS::EC2::Instance
, orAWS::S3::Bucket
.
When you specify a
resource-type
filter forListGroupResources
, Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but yourresource-type
filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, aListGroupResources
request returns aBadRequestException
error with a message similar to the following:The resource types specified as filters in the request are not valid.
The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies
This is a convenience method that creates an instance of theAWS::AllSupported
, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or Amazon CloudFront stack-based queries).ResourceFilter.Builder
avoiding the need to create one manually viaResourceFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<ResourceFilter>)
.- Parameters:
filters
- a consumer that will call methods onResourceFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
maxResults
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the
NextToken
response element is present and has a value (is not null). Include that value as theNextToken
request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.- Parameters:
maxResults
- The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, theNextToken
response element is present and has a value (is not null). Include that value as theNextToken
request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value provided by a previous call'sNextToken
response to indicate where the output should continue from.- Parameters:
nextToken
- The parameter for receiving additional results if you receive aNextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value provided by a previous call'sNextToken
response to indicate where the output should continue from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListGroupResourcesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListGroupResourcesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-