@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSResourceGroupsAsync extends AWSResourceGroups
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSResourceGroupsAsync
instead.
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
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<CreateGroupResult> |
createGroupAsync(CreateGroupRequest createGroupRequest)
Creates a resource group with the specified name and description.
|
Future<CreateGroupResult> |
createGroupAsync(CreateGroupRequest createGroupRequest,
AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
Creates a resource group with the specified name and description.
|
Future<DeleteGroupResult> |
deleteGroupAsync(DeleteGroupRequest deleteGroupRequest)
Deletes the specified resource group.
|
Future<DeleteGroupResult> |
deleteGroupAsync(DeleteGroupRequest deleteGroupRequest,
AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
Deletes the specified resource group.
|
Future<GetGroupResult> |
getGroupAsync(GetGroupRequest getGroupRequest)
Returns information about a specified resource group.
|
Future<GetGroupResult> |
getGroupAsync(GetGroupRequest getGroupRequest,
AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
Returns information about a specified resource group.
|
Future<GetGroupConfigurationResult> |
getGroupConfigurationAsync(GetGroupConfigurationRequest getGroupConfigurationRequest)
Returns the service configuration associated with the specified resource group.
|
Future<GetGroupConfigurationResult> |
getGroupConfigurationAsync(GetGroupConfigurationRequest getGroupConfigurationRequest,
AsyncHandler<GetGroupConfigurationRequest,GetGroupConfigurationResult> asyncHandler)
Returns the service configuration associated with the specified resource group.
|
Future<GetGroupQueryResult> |
getGroupQueryAsync(GetGroupQueryRequest getGroupQueryRequest)
Retrieves the resource query associated with the specified resource group.
|
Future<GetGroupQueryResult> |
getGroupQueryAsync(GetGroupQueryRequest getGroupQueryRequest,
AsyncHandler<GetGroupQueryRequest,GetGroupQueryResult> asyncHandler)
Retrieves the resource query associated with the specified resource group.
|
Future<GetTagsResult> |
getTagsAsync(GetTagsRequest getTagsRequest)
Returns a list of tags that are associated with a resource group, specified by an ARN.
|
Future<GetTagsResult> |
getTagsAsync(GetTagsRequest getTagsRequest,
AsyncHandler<GetTagsRequest,GetTagsResult> asyncHandler)
Returns a list of tags that are associated with a resource group, specified by an ARN.
|
Future<GroupResourcesResult> |
groupResourcesAsync(GroupResourcesRequest groupResourcesRequest)
Adds the specified resources to the specified group.
|
Future<GroupResourcesResult> |
groupResourcesAsync(GroupResourcesRequest groupResourcesRequest,
AsyncHandler<GroupResourcesRequest,GroupResourcesResult> asyncHandler)
Adds the specified resources to the specified group.
|
Future<ListGroupResourcesResult> |
listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest)
Returns a list of ARNs of the resources that are members of a specified resource group.
|
Future<ListGroupResourcesResult> |
listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest,
AsyncHandler<ListGroupResourcesRequest,ListGroupResourcesResult> asyncHandler)
Returns a list of ARNs of the resources that are members of a specified resource group.
|
Future<ListGroupsResult> |
listGroupsAsync(ListGroupsRequest listGroupsRequest)
Returns a list of existing resource groups in your account.
|
Future<ListGroupsResult> |
listGroupsAsync(ListGroupsRequest listGroupsRequest,
AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
Returns a list of existing resource groups in your account.
|
Future<PutGroupConfigurationResult> |
putGroupConfigurationAsync(PutGroupConfigurationRequest putGroupConfigurationRequest)
Attaches a service configuration to the specified group.
|
Future<PutGroupConfigurationResult> |
putGroupConfigurationAsync(PutGroupConfigurationRequest putGroupConfigurationRequest,
AsyncHandler<PutGroupConfigurationRequest,PutGroupConfigurationResult> asyncHandler)
Attaches a service configuration to the specified group.
|
Future<SearchResourcesResult> |
searchResourcesAsync(SearchResourcesRequest searchResourcesRequest)
Returns a list of AWS resource identifiers that matches the specified query.
|
Future<SearchResourcesResult> |
searchResourcesAsync(SearchResourcesRequest searchResourcesRequest,
AsyncHandler<SearchResourcesRequest,SearchResourcesResult> asyncHandler)
Returns a list of AWS resource identifiers that matches the specified query.
|
Future<TagResult> |
tagAsync(TagRequest tagRequest)
Adds tags to a resource group with the specified ARN.
|
Future<TagResult> |
tagAsync(TagRequest tagRequest,
AsyncHandler<TagRequest,TagResult> asyncHandler)
Adds tags to a resource group with the specified ARN.
|
Future<UngroupResourcesResult> |
ungroupResourcesAsync(UngroupResourcesRequest ungroupResourcesRequest)
Removes the specified resources from the specified group.
|
Future<UngroupResourcesResult> |
ungroupResourcesAsync(UngroupResourcesRequest ungroupResourcesRequest,
AsyncHandler<UngroupResourcesRequest,UngroupResourcesResult> asyncHandler)
Removes the specified resources from the specified group.
|
Future<UntagResult> |
untagAsync(UntagRequest untagRequest)
Deletes tags from a specified resource group.
|
Future<UntagResult> |
untagAsync(UntagRequest untagRequest,
AsyncHandler<UntagRequest,UntagResult> asyncHandler)
Deletes tags from a specified resource group.
|
Future<UpdateGroupResult> |
updateGroupAsync(UpdateGroupRequest updateGroupRequest)
Updates the description for an existing group.
|
Future<UpdateGroupResult> |
updateGroupAsync(UpdateGroupRequest updateGroupRequest,
AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
Updates the description for an existing group.
|
Future<UpdateGroupQueryResult> |
updateGroupQueryAsync(UpdateGroupQueryRequest updateGroupQueryRequest)
Updates the resource query of a group.
|
Future<UpdateGroupQueryResult> |
updateGroupQueryAsync(UpdateGroupQueryRequest updateGroupQueryRequest,
AsyncHandler<UpdateGroupQueryRequest,UpdateGroupQueryResult> asyncHandler)
Updates the resource query of a group.
|
createGroup, deleteGroup, getCachedResponseMetadata, getGroup, getGroupConfiguration, getGroupQuery, getTags, groupResources, listGroupResources, listGroups, putGroupConfiguration, searchResources, shutdown, tag, ungroupResources, untag, updateGroup, updateGroupQuery
Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest)
Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration. For more information about constructing a resource query, see Create a tag-based group in Resource Groups. For more information about service configurations, see Service configurations for resource groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:CreateGroup
createGroupRequest
- Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration. For more information about constructing a resource query, see Create a tag-based group in Resource Groups. For more information about service configurations, see Service configurations for resource groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:CreateGroup
createGroupRequest
- asyncHandler
- 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.Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest)
Deletes 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
deleteGroupRequest
- Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
Deletes 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
deleteGroupRequest
- asyncHandler
- 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.Future<GetGroupResult> getGroupAsync(GetGroupRequest getGroupRequest)
Returns information about a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroup
getGroupRequest
- Future<GetGroupResult> getGroupAsync(GetGroupRequest getGroupRequest, AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
Returns information about a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroup
getGroupRequest
- asyncHandler
- 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.Future<GetGroupConfigurationResult> getGroupConfigurationAsync(GetGroupConfigurationRequest getGroupConfigurationRequest)
Returns 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
getGroupConfigurationRequest
- Future<GetGroupConfigurationResult> getGroupConfigurationAsync(GetGroupConfigurationRequest getGroupConfigurationRequest, AsyncHandler<GetGroupConfigurationRequest,GetGroupConfigurationResult> asyncHandler)
Returns 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
getGroupConfigurationRequest
- asyncHandler
- 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.Future<GetGroupQueryResult> getGroupQueryAsync(GetGroupQueryRequest getGroupQueryRequest)
Retrieves 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
getGroupQueryRequest
- Future<GetGroupQueryResult> getGroupQueryAsync(GetGroupQueryRequest getGroupQueryRequest, AsyncHandler<GetGroupQueryRequest,GetGroupQueryResult> asyncHandler)
Retrieves 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
getGroupQueryRequest
- asyncHandler
- 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.Future<GetTagsResult> getTagsAsync(GetTagsRequest getTagsRequest)
Returns 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
getTagsRequest
- Future<GetTagsResult> getTagsAsync(GetTagsRequest getTagsRequest, AsyncHandler<GetTagsRequest,GetTagsResult> asyncHandler)
Returns 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
getTagsRequest
- asyncHandler
- 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.Future<GroupResourcesResult> groupResourcesAsync(GroupResourcesRequest groupResourcesRequest)
Adds the specified resources to the specified group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GroupResources
groupResourcesRequest
- Future<GroupResourcesResult> groupResourcesAsync(GroupResourcesRequest groupResourcesRequest, AsyncHandler<GroupResourcesRequest,GroupResourcesResult> asyncHandler)
Adds the specified resources to the specified group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GroupResources
groupResourcesRequest
- asyncHandler
- 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.Future<ListGroupResourcesResult> listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest)
Returns 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
listGroupResourcesRequest
- Future<ListGroupResourcesResult> listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest, AsyncHandler<ListGroupResourcesRequest,ListGroupResourcesResult> asyncHandler)
Returns 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
listGroupResourcesRequest
- asyncHandler
- 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.Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest)
Returns a list of existing resource groups in your account.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroups
listGroupsRequest
- Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
Returns a list of existing resource groups in your account.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroups
listGroupsRequest
- asyncHandler
- 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.Future<PutGroupConfigurationResult> putGroupConfigurationAsync(PutGroupConfigurationRequest putGroupConfigurationRequest)
Attaches 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
putGroupConfigurationRequest
- Future<PutGroupConfigurationResult> putGroupConfigurationAsync(PutGroupConfigurationRequest putGroupConfigurationRequest, AsyncHandler<PutGroupConfigurationRequest,PutGroupConfigurationResult> asyncHandler)
Attaches 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
putGroupConfigurationRequest
- asyncHandler
- 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.Future<SearchResourcesResult> searchResourcesAsync(SearchResourcesRequest searchResourcesRequest)
Returns a list of AWS 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
searchResourcesRequest
- Future<SearchResourcesResult> searchResourcesAsync(SearchResourcesRequest searchResourcesRequest, AsyncHandler<SearchResourcesRequest,SearchResourcesResult> asyncHandler)
Returns a list of AWS 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
searchResourcesRequest
- asyncHandler
- 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.Future<TagResult> tagAsync(TagRequest tagRequest)
Adds 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
tagRequest
- Future<TagResult> tagAsync(TagRequest tagRequest, AsyncHandler<TagRequest,TagResult> asyncHandler)
Adds 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
tagRequest
- asyncHandler
- 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.Future<UngroupResourcesResult> ungroupResourcesAsync(UngroupResourcesRequest ungroupResourcesRequest)
Removes the specified resources from the specified group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:UngroupResources
ungroupResourcesRequest
- Future<UngroupResourcesResult> ungroupResourcesAsync(UngroupResourcesRequest ungroupResourcesRequest, AsyncHandler<UngroupResourcesRequest,UngroupResourcesResult> asyncHandler)
Removes the specified resources from the specified group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:UngroupResources
ungroupResourcesRequest
- asyncHandler
- 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.Future<UntagResult> untagAsync(UntagRequest untagRequest)
Deletes tags from a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:Untag
untagRequest
- Future<UntagResult> untagAsync(UntagRequest untagRequest, AsyncHandler<UntagRequest,UntagResult> asyncHandler)
Deletes tags from a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:Untag
untagRequest
- asyncHandler
- 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.Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest)
Updates 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
updateGroupRequest
- Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
Updates 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
updateGroupRequest
- asyncHandler
- 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.Future<UpdateGroupQueryResult> updateGroupQueryAsync(UpdateGroupQueryRequest updateGroupQueryRequest)
Updates 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
updateGroupQueryRequest
- Future<UpdateGroupQueryResult> updateGroupQueryAsync(UpdateGroupQueryRequest updateGroupQueryRequest, AsyncHandler<UpdateGroupQueryRequest,UpdateGroupQueryResult> asyncHandler)
Updates 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
updateGroupQueryRequest
- asyncHandler
- 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.