@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.
Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases, and Amazon Simple Storage Service 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 Amazon Web Services Systems Manager Automation documents, on tag-related resources in Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in Amazon Web Services Systems Manager that shows 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 Resource Groups User Guide.
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 Amazon Web Services resources based on a resource query
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, createGroup, deleteGroup, getAccountSettings, getCachedResponseMetadata, getGroup, getGroupConfiguration, getGroupQuery, getTags, groupResources, listGroupResources, listGroups, putGroupConfiguration, searchResources, tag, ungroupResources, untag, updateAccountSettings, 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, getAccountSettings, getCachedResponseMetadata, getGroup, getGroupConfiguration, getGroupQuery, getTags, groupResources, listGroupResources, listGroups, putGroupConfiguration, searchResources, tag, ungroupResources, untag, updateAccountSettings, 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 either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:CreateGroup
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 either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:CreateGroup
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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:DeleteGroup
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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:DeleteGroup
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<GetAccountSettingsResult> getAccountSettingsAsync(GetAccountSettingsRequest request)
AWSResourceGroupsAsyncRetrieves the current status of optional features in Resource Groups.
getAccountSettingsAsync in interface AWSResourceGroupsAsyncpublic Future<GetAccountSettingsResult> getAccountSettingsAsync(GetAccountSettingsRequest request, AsyncHandler<GetAccountSettingsRequest,GetAccountSettingsResult> asyncHandler)
AWSResourceGroupsAsyncRetrieves the current status of optional features in Resource Groups.
getAccountSettingsAsync 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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroup
getGroupAsync in interface AWSResourceGroupsAsyncpublic Future<GetGroupResult> getGroupAsync(GetGroupRequest request, AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
AWSResourceGroupsAsyncReturns information about a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroup
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)
AWSResourceGroupsAsyncRetrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroupConfiguration
getGroupConfigurationAsync in interface AWSResourceGroupsAsyncpublic Future<GetGroupConfigurationResult> getGroupConfigurationAsync(GetGroupConfigurationRequest request, AsyncHandler<GetGroupConfigurationRequest,GetGroupConfigurationResult> asyncHandler)
AWSResourceGroupsAsyncRetrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroupConfiguration
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. For more information about resource queries, see Create a tag-based group in Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroupQuery
getGroupQueryAsync in interface AWSResourceGroupsAsyncpublic Future<GetGroupQueryResult> getGroupQueryAsync(GetGroupQueryRequest request, AsyncHandler<GetGroupQueryRequest,GetGroupQueryResult> asyncHandler)
AWSResourceGroupsAsyncRetrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroupQuery
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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetTags
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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetTags
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.
You can use this operation with only resource groups that are configured with the following types:
AWS::EC2::HostManagement
AWS::EC2::CapacityReservationPool
Other resource group type and resource types aren't currently supported by this operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GroupResources
groupResourcesAsync in interface AWSResourceGroupsAsyncpublic Future<GroupResourcesResult> groupResourcesAsync(GroupResourcesRequest request, AsyncHandler<GroupResourcesRequest,GroupResourcesResult> asyncHandler)
AWSResourceGroupsAsyncAdds the specified resources to the specified group.
You can use this operation with only resource groups that are configured with the following types:
AWS::EC2::HostManagement
AWS::EC2::CapacityReservationPool
Other resource group type and resource types aren't currently supported by this operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GroupResources
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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroupResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroupResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroups
listGroupsAsync in interface AWSResourceGroupsAsyncpublic Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
AWSResourceGroupsAsyncReturns a list of existing Resource Groups in your account.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroups
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<PutGroupConfigurationResult> putGroupConfigurationAsync(PutGroupConfigurationRequest request)
AWSResourceGroupsAsyncAttaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:PutGroupConfiguration
putGroupConfigurationAsync in interface AWSResourceGroupsAsyncpublic Future<PutGroupConfigurationResult> putGroupConfigurationAsync(PutGroupConfigurationRequest request, AsyncHandler<PutGroupConfigurationRequest,PutGroupConfigurationResult> asyncHandler)
AWSResourceGroupsAsyncAttaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:PutGroupConfiguration
putGroupConfigurationAsync 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 Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:SearchResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
searchResourcesAsync in interface AWSResourceGroupsAsyncpublic Future<SearchResourcesResult> searchResourcesAsync(SearchResourcesRequest request, AsyncHandler<SearchResourcesRequest,SearchResourcesResult> asyncHandler)
AWSResourceGroupsAsyncReturns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:SearchResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:Tag
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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:Tag
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. This operation works only with static groups that you populated using the GroupResources operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:UngroupResources
ungroupResourcesAsync in interface AWSResourceGroupsAsyncpublic Future<UngroupResourcesResult> ungroupResourcesAsync(UngroupResourcesRequest request, AsyncHandler<UngroupResourcesRequest,UngroupResourcesResult> asyncHandler)
AWSResourceGroupsAsyncRemoves the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:UngroupResources
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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:Untag
untagAsync in interface AWSResourceGroupsAsyncpublic Future<UntagResult> untagAsync(UntagRequest request, AsyncHandler<UntagRequest,UntagResult> asyncHandler)
AWSResourceGroupsAsyncDeletes tags from a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:Untag
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<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest request)
AWSResourceGroupsAsyncTurns on or turns off optional features in Resource Groups.
The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS. You
can call the GetAccountSettings operation to check for completion by looking for
GroupLifecycleEventsStatus to change to ACTIVE.
updateAccountSettingsAsync in interface AWSResourceGroupsAsyncpublic Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest request, AsyncHandler<UpdateAccountSettingsRequest,UpdateAccountSettingsResult> asyncHandler)
AWSResourceGroupsAsyncTurns on or turns off optional features in Resource Groups.
The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS. You
can call the GetAccountSettings operation to check for completion by looking for
GroupLifecycleEventsStatus to change to ACTIVE.
updateAccountSettingsAsync 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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:UpdateGroup
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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:UpdateGroup
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. For more information about resource queries, see Create a tag-based group in Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:UpdateGroupQuery
updateGroupQueryAsync in interface AWSResourceGroupsAsyncpublic Future<UpdateGroupQueryResult> updateGroupQueryAsync(UpdateGroupQueryRequest request, AsyncHandler<UpdateGroupQueryRequest,UpdateGroupQueryResult> asyncHandler)
AWSResourceGroupsAsyncUpdates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:UpdateGroupQuery
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 AWSResourceGroupsClient