@Generated(value="software.amazon.awssdk:codegen") public interface ResourceGroupsClient extends SdkClient
builder()
method.
AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances, Amazon Relational Database Service databases, and Amazon S3 buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource groups enable you to automate management tasks, such as those in AWS Systems Manager Automation documents, on tag-related resources in AWS Systems Manager. Groups of tagged resources also let you quickly view a custom console in AWS Systems Manager that shows AWS Config compliance and other monitoring data about member resources.
To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.
For more information about Resource Groups, see the AWS Resource Groups User Guide.
AWS Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.
Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities
Applying, editing, and removing tags from resource groups
Resolving resource group member ARNs so they can be returned as search results
Getting data about resources that are members of a group
Searching AWS resources based on a resource query
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static ResourceGroupsClientBuilder |
builder()
Create a builder that can be used to configure and create a
ResourceGroupsClient . |
static ResourceGroupsClient |
create()
Create a
ResourceGroupsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateGroupResponse |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group with a specified name, description, and resource query.
|
default CreateGroupResponse |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group with a specified name, description, and resource query.
|
default DeleteGroupResponse |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a specified resource group.
|
default DeleteGroupResponse |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a specified resource group.
|
default GetGroupResponse |
getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
Returns information about a specified resource group.
|
default GetGroupResponse |
getGroup(GetGroupRequest getGroupRequest)
Returns information about a specified resource group.
|
default GetGroupQueryResponse |
getGroupQuery(Consumer<GetGroupQueryRequest.Builder> getGroupQueryRequest)
Returns the resource query associated with the specified resource group.
|
default GetGroupQueryResponse |
getGroupQuery(GetGroupQueryRequest getGroupQueryRequest)
Returns the resource query associated with the specified resource group.
|
default GetTagsResponse |
getTags(Consumer<GetTagsRequest.Builder> getTagsRequest)
Returns a list of tags that are associated with a resource, specified by an ARN.
|
default GetTagsResponse |
getTags(GetTagsRequest getTagsRequest)
Returns a list of tags that are associated with a resource, specified by an ARN.
|
default ListGroupResourcesResponse |
listGroupResources(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest)
Returns a list of ARNs of resources that are members of a specified resource group.
|
default ListGroupResourcesResponse |
listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest)
Returns a list of ARNs of resources that are members of a specified resource group.
|
default ListGroupResourcesIterable |
listGroupResourcesPaginator(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest)
Returns a list of ARNs of resources that are members of a specified resource group.
|
default ListGroupResourcesIterable |
listGroupResourcesPaginator(ListGroupResourcesRequest listGroupResourcesRequest)
Returns a list of ARNs of resources that are members of a specified resource group.
|
default ListGroupsResponse |
listGroups()
Returns a list of existing resource groups in your account.
|
default ListGroupsResponse |
listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns a list of existing resource groups in your account.
|
default ListGroupsResponse |
listGroups(ListGroupsRequest listGroupsRequest)
Returns a list of existing resource groups in your account.
|
default ListGroupsIterable |
listGroupsPaginator()
Returns a list of existing resource groups in your account.
|
default ListGroupsIterable |
listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns a list of existing resource groups in your account.
|
default ListGroupsIterable |
listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Returns a list of existing resource groups in your account.
|
default SearchResourcesResponse |
searchResources(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest)
Returns a list of AWS resource identifiers that matches a specified query.
|
default SearchResourcesResponse |
searchResources(SearchResourcesRequest searchResourcesRequest)
Returns a list of AWS resource identifiers that matches a specified query.
|
default SearchResourcesIterable |
searchResourcesPaginator(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest)
Returns a list of AWS resource identifiers that matches a specified query.
|
default SearchResourcesIterable |
searchResourcesPaginator(SearchResourcesRequest searchResourcesRequest)
Returns a list of AWS resource identifiers that matches a specified query.
|
static ServiceMetadata |
serviceMetadata() |
default TagResponse |
tag(Consumer<TagRequest.Builder> tagRequest)
Adds specified tags to a resource with the specified ARN.
|
default TagResponse |
tag(TagRequest tagRequest)
Adds specified tags to a resource with the specified ARN.
|
default UntagResponse |
untag(Consumer<UntagRequest.Builder> untagRequest)
Deletes specified tags from a specified resource.
|
default UntagResponse |
untag(UntagRequest untagRequest)
Deletes specified tags from a specified resource.
|
default UpdateGroupResponse |
updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Updates an existing group with a new or changed description.
|
default UpdateGroupResponse |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates an existing group with a new or changed description.
|
default UpdateGroupQueryResponse |
updateGroupQuery(Consumer<UpdateGroupQueryRequest.Builder> updateGroupQueryRequest)
Updates the resource query of a group.
|
default UpdateGroupQueryResponse |
updateGroupQuery(UpdateGroupQueryRequest updateGroupQueryRequest)
Updates the resource query of a group.
|
serviceName
close
static final String SERVICE_NAME
static ResourceGroupsClient create()
ResourceGroupsClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ResourceGroupsClientBuilder builder()
ResourceGroupsClient
.default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Creates a group with a specified name, description, and resource query.
createGroupRequest
- BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Creates a group with a specified name, description, and resource query.
This is a convenience which creates an instance of the CreateGroupRequest.Builder
avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest
- A Consumer
that will call methods on CreateGroupInput.Builder
to create a request.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Deletes a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure.
deleteGroupRequest
- BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Deletes a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure.
This is a convenience which creates an instance of the DeleteGroupRequest.Builder
avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest
- A Consumer
that will call methods on DeleteGroupInput.Builder
to create a request.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupResponse getGroup(GetGroupRequest getGroupRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns information about a specified resource group.
getGroupRequest
- BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupResponse getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns information about a specified resource group.
This is a convenience which creates an instance of the GetGroupRequest.Builder
avoiding the need to
create one manually via GetGroupRequest.builder()
getGroupRequest
- A Consumer
that will call methods on GetGroupInput.Builder
to create a request.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupQueryResponse getGroupQuery(GetGroupQueryRequest getGroupQueryRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns the resource query associated with the specified resource group.
getGroupQueryRequest
- BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGroupQueryResponse getGroupQuery(Consumer<GetGroupQueryRequest.Builder> getGroupQueryRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns the resource query associated with the specified resource group.
This is a convenience which creates an instance of the GetGroupQueryRequest.Builder
avoiding the need to
create one manually via GetGroupQueryRequest.builder()
getGroupQueryRequest
- A Consumer
that will call methods on GetGroupQueryInput.Builder
to create a request.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTagsResponse getTags(GetTagsRequest getTagsRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of tags that are associated with a resource, specified by an ARN.
getTagsRequest
- BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTagsResponse getTags(Consumer<GetTagsRequest.Builder> getTagsRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of tags that are associated with a resource, specified by an ARN.
This is a convenience which creates an instance of the GetTagsRequest.Builder
avoiding the need to create
one manually via GetTagsRequest.builder()
getTagsRequest
- A Consumer
that will call methods on GetTagsInput.Builder
to create a request.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupResourcesResponse listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest) throws UnauthorizedException, BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of ARNs of resources that are members of a specified resource group.
listGroupResourcesRequest
- UnauthorizedException
- The request has not been applied because it lacks valid authentication credentials for the target
resource.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupResourcesResponse listGroupResources(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest) throws UnauthorizedException, BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of ARNs of resources that are members of a specified resource group.
This is a convenience which creates an instance of the ListGroupResourcesRequest.Builder
avoiding the
need to create one manually via ListGroupResourcesRequest.builder()
listGroupResourcesRequest
- A Consumer
that will call methods on ListGroupResourcesInput.Builder
to create a request.UnauthorizedException
- The request has not been applied because it lacks valid authentication credentials for the target
resource.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupResourcesIterable listGroupResourcesPaginator(ListGroupResourcesRequest listGroupResourcesRequest) throws UnauthorizedException, BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of ARNs of resources that are members of a specified resource group.
This is a variant of
listGroupResources(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesIterable responses = client.listGroupResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesIterable responses = client .listGroupResourcesPaginator(request); for (software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesIterable responses = client.listGroupResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroupResources(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesRequest)
operation.
listGroupResourcesRequest
- UnauthorizedException
- The request has not been applied because it lacks valid authentication credentials for the target
resource.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupResourcesIterable listGroupResourcesPaginator(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest) throws UnauthorizedException, BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of ARNs of resources that are members of a specified resource group.
This is a variant of
listGroupResources(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesIterable responses = client.listGroupResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesIterable responses = client .listGroupResourcesPaginator(request); for (software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesIterable responses = client.listGroupResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroupResources(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesRequest)
operation.
This is a convenience which creates an instance of the ListGroupResourcesRequest.Builder
avoiding the
need to create one manually via ListGroupResourcesRequest.builder()
listGroupResourcesRequest
- A Consumer
that will call methods on ListGroupResourcesInput.Builder
to create a request.UnauthorizedException
- The request has not been applied because it lacks valid authentication credentials for the target
resource.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsResponse listGroups() throws BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of existing resource groups in your account.
BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listGroups(ListGroupsRequest)
,
AWS API
Documentationdefault ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of existing resource groups in your account.
listGroupsRequest
- BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of existing resource groups in your account.
This is a convenience which creates an instance of the ListGroupsRequest.Builder
avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest
- A Consumer
that will call methods on ListGroupsInput.Builder
to create a request.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsIterable listGroupsPaginator() throws BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of existing resource groups in your account.
This is a variant of listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest)
operation.
BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listGroupsPaginator(ListGroupsRequest)
,
AWS API
Documentationdefault ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of existing resource groups in your account.
This is a variant of listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest)
operation.
listGroupsRequest
- BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of existing resource groups in your account.
This is a variant of listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest)
operation.
This is a convenience which creates an instance of the ListGroupsRequest.Builder
avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest
- A Consumer
that will call methods on ListGroupsInput.Builder
to create a request.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchResourcesResponse searchResources(SearchResourcesRequest searchResourcesRequest) throws UnauthorizedException, BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
searchResourcesRequest
- UnauthorizedException
- The request has not been applied because it lacks valid authentication credentials for the target
resource.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchResourcesResponse searchResources(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest) throws UnauthorizedException, BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
This is a convenience which creates an instance of the SearchResourcesRequest.Builder
avoiding the need
to create one manually via SearchResourcesRequest.builder()
searchResourcesRequest
- A Consumer
that will call methods on SearchResourcesInput.Builder
to create a request.UnauthorizedException
- The request has not been applied because it lacks valid authentication credentials for the target
resource.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchResourcesIterable searchResourcesPaginator(SearchResourcesRequest searchResourcesRequest) throws UnauthorizedException, BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
This is a variant of
searchResources(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesIterable responses = client.searchResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesIterable responses = client .searchResourcesPaginator(request); for (software.amazon.awssdk.services.resourcegroups.model.SearchResourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesIterable responses = client.searchResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
searchResources(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesRequest)
operation.
searchResourcesRequest
- UnauthorizedException
- The request has not been applied because it lacks valid authentication credentials for the target
resource.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchResourcesIterable searchResourcesPaginator(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest) throws UnauthorizedException, BadRequestException, ForbiddenException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
This is a variant of
searchResources(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesIterable responses = client.searchResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesIterable responses = client .searchResourcesPaginator(request); for (software.amazon.awssdk.services.resourcegroups.model.SearchResourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesIterable responses = client.searchResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
searchResources(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesRequest)
operation.
This is a convenience which creates an instance of the SearchResourcesRequest.Builder
avoiding the need
to create one manually via SearchResourcesRequest.builder()
searchResourcesRequest
- A Consumer
that will call methods on SearchResourcesInput.Builder
to create a request.UnauthorizedException
- The request has not been applied because it lacks valid authentication credentials for the target
resource.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResponse tag(TagRequest tagRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
tagRequest
- BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResponse tag(Consumer<TagRequest.Builder> tagRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
This is a convenience which creates an instance of the TagRequest.Builder
avoiding the need to create one
manually via TagRequest.builder()
tagRequest
- A Consumer
that will call methods on TagInput.Builder
to create a request.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResponse untag(UntagRequest untagRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Deletes specified tags from a specified resource.
untagRequest
- BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResponse untag(Consumer<UntagRequest.Builder> untagRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Deletes specified tags from a specified resource.
This is a convenience which creates an instance of the UntagRequest.Builder
avoiding the need to create
one manually via UntagRequest.builder()
untagRequest
- A Consumer
that will call methods on UntagInput.Builder
to create a request.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Updates an existing group with a new or changed description. You cannot update the name of a resource group.
updateGroupRequest
- BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Updates an existing group with a new or changed description. You cannot update the name of a resource group.
This is a convenience which creates an instance of the UpdateGroupRequest.Builder
avoiding the need to
create one manually via UpdateGroupRequest.builder()
updateGroupRequest
- A Consumer
that will call methods on UpdateGroupInput.Builder
to create a request.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateGroupQueryResponse updateGroupQuery(UpdateGroupQueryRequest updateGroupQueryRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Updates the resource query of a group.
updateGroupQueryRequest
- BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateGroupQueryResponse updateGroupQuery(Consumer<UpdateGroupQueryRequest.Builder> updateGroupQueryRequest) throws BadRequestException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, InternalServerErrorException, AwsServiceException, SdkClientException, ResourceGroupsException
Updates the resource query of a group.
This is a convenience which creates an instance of the UpdateGroupQueryRequest.Builder
avoiding the need
to create one manually via UpdateGroupQueryRequest.builder()
updateGroupQueryRequest
- A Consumer
that will call methods on UpdateGroupQueryInput.Builder
to create a request.BadRequestException
- The request does not comply with validation rules that are defined for the request parameters.ForbiddenException
- The caller is not authorized to make the request.NotFoundException
- One or more resources specified in the request do not exist.MethodNotAllowedException
- The request uses an HTTP method which is not allowed for the specified resource.TooManyRequestsException
- The caller has exceeded throttling limits.InternalServerErrorException
- An internal error occurred while processing the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.