@Generated(value="software.amazon.awssdk:codegen") public interface ResourceGroupsAsyncClient extends SdkClient, SdkAutoCloseable
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 ResourceGroupsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
ResourceGroupsAsyncClient . |
static ResourceGroupsAsyncClient |
create()
Create a
ResourceGroupsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CompletableFuture<CreateGroupResponse> |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group with a specified name, description, and resource query.
|
default CompletableFuture<CreateGroupResponse> |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group with a specified name, description, and resource query.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a specified resource group.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a specified resource group.
|
default CompletableFuture<GetGroupResponse> |
getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
Returns information about a specified resource group.
|
default CompletableFuture<GetGroupResponse> |
getGroup(GetGroupRequest getGroupRequest)
Returns information about a specified resource group.
|
default CompletableFuture<GetGroupQueryResponse> |
getGroupQuery(Consumer<GetGroupQueryRequest.Builder> getGroupQueryRequest)
Returns the resource query associated with the specified resource group.
|
default CompletableFuture<GetGroupQueryResponse> |
getGroupQuery(GetGroupQueryRequest getGroupQueryRequest)
Returns the resource query associated with the specified resource group.
|
default CompletableFuture<GetTagsResponse> |
getTags(Consumer<GetTagsRequest.Builder> getTagsRequest)
Returns a list of tags that are associated with a resource, specified by an ARN.
|
default CompletableFuture<GetTagsResponse> |
getTags(GetTagsRequest getTagsRequest)
Returns a list of tags that are associated with a resource, specified by an ARN.
|
default CompletableFuture<ListGroupResourcesResponse> |
listGroupResources(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest)
Returns a list of ARNs of resources that are members of a specified resource group.
|
default CompletableFuture<ListGroupResourcesResponse> |
listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest)
Returns a list of ARNs of resources that are members of a specified resource group.
|
default ListGroupResourcesPublisher |
listGroupResourcesPaginator(ListGroupResourcesRequest listGroupResourcesRequest)
Returns a list of ARNs of resources that are members of a specified resource group.
|
default CompletableFuture<ListGroupsResponse> |
listGroups()
Returns a list of existing resource groups in your account.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns a list of existing resource groups in your account.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(ListGroupsRequest listGroupsRequest)
Returns a list of existing resource groups in your account.
|
default ListGroupsPublisher |
listGroupsPaginator()
Returns a list of existing resource groups in your account.
|
default ListGroupsPublisher |
listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Returns a list of existing resource groups in your account.
|
default CompletableFuture<SearchResourcesResponse> |
searchResources(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest)
Returns a list of AWS resource identifiers that matches a specified query.
|
default CompletableFuture<SearchResourcesResponse> |
searchResources(SearchResourcesRequest searchResourcesRequest)
Returns a list of AWS resource identifiers that matches a specified query.
|
default SearchResourcesPublisher |
searchResourcesPaginator(SearchResourcesRequest searchResourcesRequest)
Returns a list of AWS resource identifiers that matches a specified query.
|
default CompletableFuture<TagResponse> |
tag(Consumer<TagRequest.Builder> tagRequest)
Adds specified tags to a resource with the specified ARN.
|
default CompletableFuture<TagResponse> |
tag(TagRequest tagRequest)
Adds specified tags to a resource with the specified ARN.
|
default CompletableFuture<UntagResponse> |
untag(Consumer<UntagRequest.Builder> untagRequest)
Deletes specified tags from a specified resource.
|
default CompletableFuture<UntagResponse> |
untag(UntagRequest untagRequest)
Deletes specified tags from a specified resource.
|
default CompletableFuture<UpdateGroupResponse> |
updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Updates an existing group with a new or changed description.
|
default CompletableFuture<UpdateGroupResponse> |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates an existing group with a new or changed description.
|
default CompletableFuture<UpdateGroupQueryResponse> |
updateGroupQuery(Consumer<UpdateGroupQueryRequest.Builder> updateGroupQueryRequest)
Updates the resource query of a group.
|
default CompletableFuture<UpdateGroupQueryResponse> |
updateGroupQuery(UpdateGroupQueryRequest updateGroupQueryRequest)
Updates the resource query of a group.
|
serviceName
close
static final String SERVICE_NAME
static ResourceGroupsAsyncClient create()
ResourceGroupsAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static ResourceGroupsAsyncClientBuilder builder()
ResourceGroupsAsyncClient
.default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)
Creates a group with a specified name, description, and resource query.
createGroupRequest
- default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group with a specified name, description, and resource query.
CreateGroupRequest.Builder
avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest
- a Consumer
that will call methods on CreateGroupInput.Builder
.default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)
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
- default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
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.Builder
avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest
- a Consumer
that will call methods on DeleteGroupInput.Builder
.default CompletableFuture<GetGroupResponse> getGroup(GetGroupRequest getGroupRequest)
Returns information about a specified resource group.
getGroupRequest
- default CompletableFuture<GetGroupResponse> getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
Returns information about a specified resource group.
GetGroupRequest.Builder
avoiding the need to
create one manually via GetGroupRequest.builder()
getGroupRequest
- a Consumer
that will call methods on GetGroupInput.Builder
.default CompletableFuture<GetGroupQueryResponse> getGroupQuery(GetGroupQueryRequest getGroupQueryRequest)
Returns the resource query associated with the specified resource group.
getGroupQueryRequest
- default CompletableFuture<GetGroupQueryResponse> getGroupQuery(Consumer<GetGroupQueryRequest.Builder> getGroupQueryRequest)
Returns the resource query associated with the specified resource group.
GetGroupQueryRequest.Builder
avoiding the need to
create one manually via GetGroupQueryRequest.builder()
getGroupQueryRequest
- a Consumer
that will call methods on GetGroupQueryInput.Builder
.default CompletableFuture<GetTagsResponse> getTags(GetTagsRequest getTagsRequest)
Returns a list of tags that are associated with a resource, specified by an ARN.
getTagsRequest
- default CompletableFuture<GetTagsResponse> getTags(Consumer<GetTagsRequest.Builder> getTagsRequest)
Returns a list of tags that are associated with a resource, specified by an ARN.
GetTagsRequest.Builder
avoiding the need to create
one manually via GetTagsRequest.builder()
getTagsRequest
- a Consumer
that will call methods on GetTagsInput.Builder
.default CompletableFuture<ListGroupResourcesResponse> listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest)
Returns a list of ARNs of resources that are members of a specified resource group.
listGroupResourcesRequest
- default CompletableFuture<ListGroupResourcesResponse> listGroupResources(Consumer<ListGroupResourcesRequest.Builder> listGroupResourcesRequest)
Returns a list of ARNs of resources that are members of a specified resource group.
ListGroupResourcesRequest.Builder
avoiding the
need to create one manually via ListGroupResourcesRequest.builder()
listGroupResourcesRequest
- a Consumer
that will call methods on ListGroupResourcesInput.Builder
.default ListGroupResourcesPublisher listGroupResourcesPaginator(ListGroupResourcesRequest listGroupResourcesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesPublisher publisher = client.listGroupResourcesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupResourcesPublisher publisher = client.listGroupResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listGroupResources(software.amazon.awssdk.services.resourcegroups.model.ListGroupResourcesRequest)
operation.
listGroupResourcesRequest
- default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)
Returns a list of existing resource groups in your account.
listGroupsRequest
- default CompletableFuture<ListGroupsResponse> listGroups()
Returns a list of existing resource groups in your account.
default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns a list of existing resource groups in your account.
ListGroupsRequest.Builder
avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest
- a Consumer
that will call methods on ListGroupsInput.Builder
.default ListGroupsPublisher listGroupsPaginator(ListGroupsRequest listGroupsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest)
operation.
listGroupsRequest
- default ListGroupsPublisher listGroupsPaginator()
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest)
operation.
default CompletableFuture<SearchResourcesResponse> searchResources(SearchResourcesRequest searchResourcesRequest)
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
- default CompletableFuture<SearchResourcesResponse> searchResources(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest)
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.Builder
avoiding the need
to create one manually via SearchResourcesRequest.builder()
searchResourcesRequest
- a Consumer
that will call methods on SearchResourcesInput.Builder
.default SearchResourcesPublisher searchResourcesPaginator(SearchResourcesRequest searchResourcesRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesPublisher publisher = client.searchResourcesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroups.paginators.SearchResourcesPublisher publisher = client.searchResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroups.model.SearchResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
searchResources(software.amazon.awssdk.services.resourcegroups.model.SearchResourcesRequest)
operation.
searchResourcesRequest
- default CompletableFuture<TagResponse> tag(TagRequest tagRequest)
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
- default CompletableFuture<TagResponse> tag(Consumer<TagRequest.Builder> tagRequest)
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.Builder
avoiding the need to create one
manually via TagRequest.builder()
tagRequest
- a Consumer
that will call methods on TagInput.Builder
.default CompletableFuture<UntagResponse> untag(UntagRequest untagRequest)
Deletes specified tags from a specified resource.
untagRequest
- default CompletableFuture<UntagResponse> untag(Consumer<UntagRequest.Builder> untagRequest)
Deletes specified tags from a specified resource.
UntagRequest.Builder
avoiding the need to create
one manually via UntagRequest.builder()
untagRequest
- a Consumer
that will call methods on UntagInput.Builder
.default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest)
Updates an existing group with a new or changed description. You cannot update the name of a resource group.
updateGroupRequest
- default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Updates an existing group with a new or changed description. You cannot update the name of a resource group.
UpdateGroupRequest.Builder
avoiding the need to
create one manually via UpdateGroupRequest.builder()
updateGroupRequest
- a Consumer
that will call methods on UpdateGroupInput.Builder
.default CompletableFuture<UpdateGroupQueryResponse> updateGroupQuery(UpdateGroupQueryRequest updateGroupQueryRequest)
Updates the resource query of a group.
updateGroupQueryRequest
- default CompletableFuture<UpdateGroupQueryResponse> updateGroupQuery(Consumer<UpdateGroupQueryRequest.Builder> updateGroupQueryRequest)
Updates the resource query of a group.
UpdateGroupQueryRequest.Builder
avoiding the need
to create one manually via UpdateGroupQueryRequest.builder()
updateGroupQueryRequest
- a Consumer
that will call methods on UpdateGroupQueryInput.Builder
.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.