@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSResourceGroupsAsyncClient extends AWSResourceGroupsClient implements AWSResourceGroupsAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSResourceGroupsAsyncClientBuilder |
asyncBuilder() |
Future<CreateGroupResult> |
createGroupAsync(CreateGroupRequest request)
Creates a resource group with the specified name and description.
|
Future<CreateGroupResult> |
createGroupAsync(CreateGroupRequest request,
AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
Creates a resource group with the specified name and description.
|
Future<DeleteGroupResult> |
deleteGroupAsync(DeleteGroupRequest request)
Deletes the specified resource group.
|
Future<DeleteGroupResult> |
deleteGroupAsync(DeleteGroupRequest request,
AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
Deletes the specified resource group.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<GetGroupResult> |
getGroupAsync(GetGroupRequest request)
Returns information about a specified resource group.
|
Future<GetGroupResult> |
getGroupAsync(GetGroupRequest request,
AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
Returns information about a specified resource group.
|
Future<GetGroupConfigurationResult> |
getGroupConfigurationAsync(GetGroupConfigurationRequest request)
Returns the service configuration associated with the specified resource group.
|
Future<GetGroupConfigurationResult> |
getGroupConfigurationAsync(GetGroupConfigurationRequest request,
AsyncHandler<GetGroupConfigurationRequest,GetGroupConfigurationResult> asyncHandler)
Returns the service configuration associated with the specified resource group.
|
Future<GetGroupQueryResult> |
getGroupQueryAsync(GetGroupQueryRequest request)
Retrieves the resource query associated with the specified resource group.
|
Future<GetGroupQueryResult> |
getGroupQueryAsync(GetGroupQueryRequest request,
AsyncHandler<GetGroupQueryRequest,GetGroupQueryResult> asyncHandler)
Retrieves the resource query associated with the specified resource group.
|
Future<GetTagsResult> |
getTagsAsync(GetTagsRequest request)
Returns a list of tags that are associated with a resource group, specified by an ARN.
|
Future<GetTagsResult> |
getTagsAsync(GetTagsRequest request,
AsyncHandler<GetTagsRequest,GetTagsResult> asyncHandler)
Returns a list of tags that are associated with a resource group, specified by an ARN.
|
Future<GroupResourcesResult> |
groupResourcesAsync(GroupResourcesRequest request)
Adds the specified resources to the specified group.
|
Future<GroupResourcesResult> |
groupResourcesAsync(GroupResourcesRequest request,
AsyncHandler<GroupResourcesRequest,GroupResourcesResult> asyncHandler)
Adds the specified resources to the specified group.
|
Future<ListGroupResourcesResult> |
listGroupResourcesAsync(ListGroupResourcesRequest request)
Returns a list of ARNs of the resources that are members of a specified resource group.
|
Future<ListGroupResourcesResult> |
listGroupResourcesAsync(ListGroupResourcesRequest request,
AsyncHandler<ListGroupResourcesRequest,ListGroupResourcesResult> asyncHandler)
Returns a list of ARNs of the resources that are members of a specified resource group.
|
Future<ListGroupsResult> |
listGroupsAsync(ListGroupsRequest request)
Returns a list of existing resource groups in your account.
|
Future<ListGroupsResult> |
listGroupsAsync(ListGroupsRequest request,
AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
Returns a list of existing resource groups in your account.
|
Future<SearchResourcesResult> |
searchResourcesAsync(SearchResourcesRequest request)
Returns a list of AWS resource identifiers that matches tne specified query.
|
Future<SearchResourcesResult> |
searchResourcesAsync(SearchResourcesRequest request,
AsyncHandler<SearchResourcesRequest,SearchResourcesResult> asyncHandler)
Returns a list of AWS resource identifiers that matches tne specified query.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<TagResult> |
tagAsync(TagRequest request)
Adds tags to a resource group with the specified ARN.
|
Future<TagResult> |
tagAsync(TagRequest request,
AsyncHandler<TagRequest,TagResult> asyncHandler)
Adds tags to a resource group with the specified ARN.
|
Future<UngroupResourcesResult> |
ungroupResourcesAsync(UngroupResourcesRequest request)
Removes the specified resources from the specified group.
|
Future<UngroupResourcesResult> |
ungroupResourcesAsync(UngroupResourcesRequest request,
AsyncHandler<UngroupResourcesRequest,UngroupResourcesResult> asyncHandler)
Removes the specified resources from the specified group.
|
Future<UntagResult> |
untagAsync(UntagRequest request)
Deletes tags from a specified resource group.
|
Future<UntagResult> |
untagAsync(UntagRequest request,
AsyncHandler<UntagRequest,UntagResult> asyncHandler)
Deletes tags from a specified resource group.
|
Future<UpdateGroupResult> |
updateGroupAsync(UpdateGroupRequest request)
Updates the description for an existing group.
|
Future<UpdateGroupResult> |
updateGroupAsync(UpdateGroupRequest request,
AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
Updates the description for an existing group.
|
Future<UpdateGroupQueryResult> |
updateGroupQueryAsync(UpdateGroupQueryRequest request)
Updates the resource query of a group.
|
Future<UpdateGroupQueryResult> |
updateGroupQueryAsync(UpdateGroupQueryRequest request,
AsyncHandler<UpdateGroupQueryRequest,UpdateGroupQueryResult> asyncHandler)
Updates the resource query of a group.
|
builder, createGroup, deleteGroup, getCachedResponseMetadata, getGroup, getGroupConfiguration, getGroupQuery, getTags, groupResources, listGroupResources, listGroups, searchResources, tag, ungroupResources, untag, updateGroup, updateGroupQueryaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateGroup, deleteGroup, getCachedResponseMetadata, getGroup, getGroupConfiguration, getGroupQuery, getTags, groupResources, listGroupResources, listGroups, searchResources, tag, ungroupResources, untag, updateGroup, updateGroupQuerypublic static AWSResourceGroupsAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request)
AWSResourceGroupsAsyncCreates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration.
createGroupAsync in interface AWSResourceGroupsAsyncpublic Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
AWSResourceGroupsAsyncCreates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration.
createGroupAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request)
AWSResourceGroupsAsyncDeletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.
deleteGroupAsync in interface AWSResourceGroupsAsyncpublic Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
AWSResourceGroupsAsyncDeletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.
deleteGroupAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetGroupResult> getGroupAsync(GetGroupRequest request)
AWSResourceGroupsAsyncReturns information about a specified resource group.
getGroupAsync in interface AWSResourceGroupsAsyncpublic Future<GetGroupResult> getGroupAsync(GetGroupRequest request, AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
AWSResourceGroupsAsyncReturns information about a specified resource group.
getGroupAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetGroupConfigurationResult> getGroupConfigurationAsync(GetGroupConfigurationRequest request)
AWSResourceGroupsAsyncReturns the service configuration associated with the specified resource group. AWS Resource Groups supports configurations for the following resource group types:
AWS::EC2::CapacityReservationPool - Amazon EC2 capacity reservation pools. For more information, see
Working with capacity reservation groups in the EC2 Users Guide.
getGroupConfigurationAsync in interface AWSResourceGroupsAsyncpublic Future<GetGroupConfigurationResult> getGroupConfigurationAsync(GetGroupConfigurationRequest request, AsyncHandler<GetGroupConfigurationRequest,GetGroupConfigurationResult> asyncHandler)
AWSResourceGroupsAsyncReturns the service configuration associated with the specified resource group. AWS Resource Groups supports configurations for the following resource group types:
AWS::EC2::CapacityReservationPool - Amazon EC2 capacity reservation pools. For more information, see
Working with capacity reservation groups in the EC2 Users Guide.
getGroupConfigurationAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetGroupQueryResult> getGroupQueryAsync(GetGroupQueryRequest request)
AWSResourceGroupsAsyncRetrieves the resource query associated with the specified resource group.
getGroupQueryAsync in interface AWSResourceGroupsAsyncpublic Future<GetGroupQueryResult> getGroupQueryAsync(GetGroupQueryRequest request, AsyncHandler<GetGroupQueryRequest,GetGroupQueryResult> asyncHandler)
AWSResourceGroupsAsyncRetrieves the resource query associated with the specified resource group.
getGroupQueryAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetTagsResult> getTagsAsync(GetTagsRequest request)
AWSResourceGroupsAsyncReturns a list of tags that are associated with a resource group, specified by an ARN.
getTagsAsync in interface AWSResourceGroupsAsyncpublic Future<GetTagsResult> getTagsAsync(GetTagsRequest request, AsyncHandler<GetTagsRequest,GetTagsResult> asyncHandler)
AWSResourceGroupsAsyncReturns a list of tags that are associated with a resource group, specified by an ARN.
getTagsAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GroupResourcesResult> groupResourcesAsync(GroupResourcesRequest request)
AWSResourceGroupsAsyncAdds the specified resources to the specified group.
groupResourcesAsync in interface AWSResourceGroupsAsyncpublic Future<GroupResourcesResult> groupResourcesAsync(GroupResourcesRequest request, AsyncHandler<GroupResourcesRequest,GroupResourcesResult> asyncHandler)
AWSResourceGroupsAsyncAdds the specified resources to the specified group.
groupResourcesAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListGroupResourcesResult> listGroupResourcesAsync(ListGroupResourcesRequest request)
AWSResourceGroupsAsyncReturns a list of ARNs of the resources that are members of a specified resource group.
listGroupResourcesAsync in interface AWSResourceGroupsAsyncpublic Future<ListGroupResourcesResult> listGroupResourcesAsync(ListGroupResourcesRequest request, AsyncHandler<ListGroupResourcesRequest,ListGroupResourcesResult> asyncHandler)
AWSResourceGroupsAsyncReturns a list of ARNs of the resources that are members of a specified resource group.
listGroupResourcesAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request)
AWSResourceGroupsAsyncReturns a list of existing resource groups in your account.
listGroupsAsync in interface AWSResourceGroupsAsyncpublic Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
AWSResourceGroupsAsyncReturns a list of existing resource groups in your account.
listGroupsAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchResourcesResult> searchResourcesAsync(SearchResourcesRequest request)
AWSResourceGroupsAsyncReturns a list of AWS resource identifiers that matches tne specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
searchResourcesAsync in interface AWSResourceGroupsAsyncpublic Future<SearchResourcesResult> searchResourcesAsync(SearchResourcesRequest request, AsyncHandler<SearchResourcesRequest,SearchResourcesResult> asyncHandler)
AWSResourceGroupsAsyncReturns a list of AWS resource identifiers that matches tne specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
searchResourcesAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResult> tagAsync(TagRequest request)
AWSResourceGroupsAsyncAdds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
tagAsync in interface AWSResourceGroupsAsyncpublic Future<TagResult> tagAsync(TagRequest request, AsyncHandler<TagRequest,TagResult> asyncHandler)
AWSResourceGroupsAsyncAdds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
tagAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UngroupResourcesResult> ungroupResourcesAsync(UngroupResourcesRequest request)
AWSResourceGroupsAsyncRemoves the specified resources from the specified group.
ungroupResourcesAsync in interface AWSResourceGroupsAsyncpublic Future<UngroupResourcesResult> ungroupResourcesAsync(UngroupResourcesRequest request, AsyncHandler<UngroupResourcesRequest,UngroupResourcesResult> asyncHandler)
AWSResourceGroupsAsyncRemoves the specified resources from the specified group.
ungroupResourcesAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResult> untagAsync(UntagRequest request)
AWSResourceGroupsAsyncDeletes tags from a specified resource group.
untagAsync in interface AWSResourceGroupsAsyncpublic Future<UntagResult> untagAsync(UntagRequest request, AsyncHandler<UntagRequest,UntagResult> asyncHandler)
AWSResourceGroupsAsyncDeletes tags from a specified resource group.
untagAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request)
AWSResourceGroupsAsyncUpdates the description for an existing group. You cannot update the name of a resource group.
updateGroupAsync in interface AWSResourceGroupsAsyncpublic Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
AWSResourceGroupsAsyncUpdates the description for an existing group. You cannot update the name of a resource group.
updateGroupAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateGroupQueryResult> updateGroupQueryAsync(UpdateGroupQueryRequest request)
AWSResourceGroupsAsyncUpdates the resource query of a group.
updateGroupQueryAsync in interface AWSResourceGroupsAsyncpublic Future<UpdateGroupQueryResult> updateGroupQueryAsync(UpdateGroupQueryRequest request, AsyncHandler<UpdateGroupQueryRequest,UpdateGroupQueryResult> asyncHandler)
AWSResourceGroupsAsyncUpdates the resource query of a group.
updateGroupQueryAsync in interface AWSResourceGroupsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSResourceGroupsshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.