com.amazonaws.services.resourcegroups

Interface AWSResourceGroupsAsync

All Superinterfaces:

AWSResourceGroups

All Known Implementing Classes:

AbstractAWSResourceGroupsAsync, AWSResourceGroupsAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSResourceGroupsAsync
extends AWSResourceGroups

Interface for accessing Resource Groups asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an 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

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

Field Summary

Fields inherited from interface com.amazonaws.services.resourcegroups.AWSResourceGroups

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<CreateGroupResult>	createGroupAsync(CreateGroupRequest createGroupRequest) Creates a group with a specified name, description, and resource query.
Future<CreateGroupResult>	createGroupAsync(CreateGroupRequest createGroupRequest, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler) Creates a group with a specified name, description, and resource query.
Future<DeleteGroupResult>	deleteGroupAsync(DeleteGroupRequest deleteGroupRequest) Deletes a specified resource group.
Future<DeleteGroupResult>	deleteGroupAsync(DeleteGroupRequest deleteGroupRequest, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler) Deletes a 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<GetGroupQueryResult>	getGroupQueryAsync(GetGroupQueryRequest getGroupQueryRequest) Returns the resource query associated with the specified resource group.
Future<GetGroupQueryResult>	getGroupQueryAsync(GetGroupQueryRequest getGroupQueryRequest, AsyncHandler<GetGroupQueryRequest,GetGroupQueryResult> asyncHandler) Returns 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<ListGroupResourcesResult>	listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest) Returns a list of ARNs of resources that are members of a specified resource group.
Future<ListGroupResourcesResult>	listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest, AsyncHandler<ListGroupResourcesRequest,ListGroupResourcesResult> asyncHandler) Returns a list of ARNs of 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<SearchResourcesResult>	searchResourcesAsync(SearchResourcesRequest searchResourcesRequest) Returns a list of AWS resource identifiers that matches a specified query.
Future<SearchResourcesResult>	searchResourcesAsync(SearchResourcesRequest searchResourcesRequest, AsyncHandler<SearchResourcesRequest,SearchResourcesResult> asyncHandler) Returns a list of AWS resource identifiers that matches a 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<UntagResult>	untagAsync(UntagRequest untagRequest) Deletes specified tags from a specified resource.
Future<UntagResult>	untagAsync(UntagRequest untagRequest, AsyncHandler<UntagRequest,UntagResult> asyncHandler) Deletes specified tags from a specified resource.
Future<UpdateGroupResult>	updateGroupAsync(UpdateGroupRequest updateGroupRequest) Updates an existing group with a new or changed description.
Future<UpdateGroupResult>	updateGroupAsync(UpdateGroupRequest updateGroupRequest, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler) Updates an existing group with a new or changed description.
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.

Methods inherited from interface com.amazonaws.services.resourcegroups.AWSResourceGroups

createGroup, deleteGroup, getCachedResponseMetadata, getGroup, getGroupQuery, getTags, listGroupResources, listGroups, searchResources, shutdown, tag, untag, updateGroup, updateGroupQuery

Method Detail

createGroupAsync

Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest)

Creates a group with a specified name, description, and resource query.

Parameters:

createGroupRequest -

Returns:

A Java Future containing the result of the CreateGroup operation returned by the service.

See Also:

AWS API Documentation

createGroupAsync

Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest,
                                           AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)

Creates a group with a specified name, description, and resource query.

Parameters:

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.

Returns:

A Java Future containing the result of the CreateGroup operation returned by the service.

See Also:

AWS API Documentation

deleteGroupAsync

Future<DeleteGroupResult> deleteGroupAsync(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.

Parameters:

deleteGroupRequest -

Returns:

A Java Future containing the result of the DeleteGroup operation returned by the service.

See Also:

AWS API Documentation

deleteGroupAsync

Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest,
                                           AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)

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.

Parameters:

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.

Returns:

A Java Future containing the result of the DeleteGroup operation returned by the service.

See Also:

AWS API Documentation

getGroupAsync

Future<GetGroupResult> getGroupAsync(GetGroupRequest getGroupRequest)

Returns information about a specified resource group.

Parameters:

getGroupRequest -

Returns:

A Java Future containing the result of the GetGroup operation returned by the service.

See Also:

AWS API Documentation

getGroupAsync

Future<GetGroupResult> getGroupAsync(GetGroupRequest getGroupRequest,
                                     AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)

Returns information about a specified resource group.

Parameters:

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.

Returns:

A Java Future containing the result of the GetGroup operation returned by the service.

See Also:

AWS API Documentation

getGroupQueryAsync

Future<GetGroupQueryResult> getGroupQueryAsync(GetGroupQueryRequest getGroupQueryRequest)

Returns the resource query associated with the specified resource group.

Parameters:

getGroupQueryRequest -

Returns:

A Java Future containing the result of the GetGroupQuery operation returned by the service.

See Also:

AWS API Documentation

getGroupQueryAsync

Future<GetGroupQueryResult> getGroupQueryAsync(GetGroupQueryRequest getGroupQueryRequest,
                                               AsyncHandler<GetGroupQueryRequest,GetGroupQueryResult> asyncHandler)

Returns the resource query associated with the specified resource group.

Parameters:

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.

Returns:

A Java Future containing the result of the GetGroupQuery operation returned by the service.

See Also:

AWS API Documentation

getTagsAsync

Future<GetTagsResult> getTagsAsync(GetTagsRequest getTagsRequest)

Returns a list of tags that are associated with a resource group, specified by an ARN.

Parameters:

getTagsRequest -

Returns:

A Java Future containing the result of the GetTags operation returned by the service.

See Also:

AWS API Documentation

getTagsAsync

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.

Parameters:

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.

Returns:

A Java Future containing the result of the GetTags operation returned by the service.

See Also:

AWS API Documentation

listGroupResourcesAsync

Future<ListGroupResourcesResult> listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest)

Returns a list of ARNs of resources that are members of a specified resource group.

Parameters:

listGroupResourcesRequest -

Returns:

A Java Future containing the result of the ListGroupResources operation returned by the service.

See Also:

AWS API Documentation

listGroupResourcesAsync

Future<ListGroupResourcesResult> listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest,
                                                         AsyncHandler<ListGroupResourcesRequest,ListGroupResourcesResult> asyncHandler)

Returns a list of ARNs of resources that are members of a specified resource group.

Parameters:

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.

Returns:

A Java Future containing the result of the ListGroupResources operation returned by the service.

See Also:

AWS API Documentation

listGroupsAsync

Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest)

Returns a list of existing resource groups in your account.

Parameters:

listGroupsRequest -

Returns:

A Java Future containing the result of the ListGroups operation returned by the service.

See Also:

AWS API Documentation

listGroupsAsync

Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest,
                                         AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)

Returns a list of existing resource groups in your account.

Parameters:

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.

Returns:

A Java Future containing the result of the ListGroups operation returned by the service.

See Also:

AWS API Documentation

searchResourcesAsync

Future<SearchResourcesResult> searchResourcesAsync(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.

Parameters:

searchResourcesRequest -

Returns:

A Java Future containing the result of the SearchResources operation returned by the service.

See Also:

AWS API Documentation

searchResourcesAsync

Future<SearchResourcesResult> searchResourcesAsync(SearchResourcesRequest searchResourcesRequest,
                                                   AsyncHandler<SearchResourcesRequest,SearchResourcesResult> asyncHandler)

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.

Parameters:

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.

Returns:

A Java Future containing the result of the SearchResources operation returned by the service.

See Also:

AWS API Documentation

tagAsync

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.

Parameters:

tagRequest -

Returns:

A Java Future containing the result of the Tag operation returned by the service.

See Also:

AWS API Documentation

tagAsync

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.

Parameters:

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.

Returns:

A Java Future containing the result of the Tag operation returned by the service.

See Also:

AWS API Documentation

untagAsync

Future<UntagResult> untagAsync(UntagRequest untagRequest)

Deletes specified tags from a specified resource.

Parameters:

untagRequest -

Returns:

A Java Future containing the result of the Untag operation returned by the service.

See Also:

AWS API Documentation

untagAsync

Future<UntagResult> untagAsync(UntagRequest untagRequest,
                               AsyncHandler<UntagRequest,UntagResult> asyncHandler)

Deletes specified tags from a specified resource.

Parameters:

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.

Returns:

A Java Future containing the result of the Untag operation returned by the service.

See Also:

AWS API Documentation

updateGroupAsync

Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest)

Updates an existing group with a new or changed description. You cannot update the name of a resource group.

Parameters:

updateGroupRequest -

Returns:

A Java Future containing the result of the UpdateGroup operation returned by the service.

See Also:

AWS API Documentation

updateGroupAsync

Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest,
                                           AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)

Updates an existing group with a new or changed description. You cannot update the name of a resource group.

Parameters:

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.

Returns:

A Java Future containing the result of the UpdateGroup operation returned by the service.

See Also:

AWS API Documentation

updateGroupQueryAsync

Future<UpdateGroupQueryResult> updateGroupQueryAsync(UpdateGroupQueryRequest updateGroupQueryRequest)

Updates the resource query of a group.

Parameters:

updateGroupQueryRequest -

Returns:

A Java Future containing the result of the UpdateGroupQuery operation returned by the service.

See Also:

AWS API Documentation

updateGroupQueryAsync

Future<UpdateGroupQueryResult> updateGroupQueryAsync(UpdateGroupQueryRequest updateGroupQueryRequest,
                                                     AsyncHandler<UpdateGroupQueryRequest,UpdateGroupQueryResult> asyncHandler)

Updates the resource query of a group.

Parameters:

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.

Returns:

A Java Future containing the result of the UpdateGroupQuery operation returned by the service.

See Also:

AWS API Documentation