com.amazonaws.services.resourcegroups.AWSResourceGroupsAsync Maven / Gradle / Ivy
/*
* Copyright 2013-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.resourcegroups;
import javax.annotation.Generated;
import com.amazonaws.services.resourcegroups.model.*;
/**
* Interface for accessing Resource Groups asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code 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
* {@link com.amazonaws.services.resourcegroups.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
*
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSResourceGroupsAsync extends AWSResourceGroups {
/**
*
* Creates a group with a specified name, description, and resource query.
*
*
* @param createGroupRequest
* @return A Java Future containing the result of the CreateGroup operation returned by the service.
* @sample AWSResourceGroupsAsync.CreateGroup
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createGroupAsync(CreateGroupRequest createGroupRequest);
/**
*
* Creates a group with a specified name, description, and resource query.
*
*
* @param createGroupRequest
* @param 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.
* @return A Java Future containing the result of the CreateGroup operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.CreateGroup
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createGroupAsync(CreateGroupRequest createGroupRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param deleteGroupRequest
* @return A Java Future containing the result of the DeleteGroup operation returned by the service.
* @sample AWSResourceGroupsAsync.DeleteGroup
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param deleteGroupRequest
* @param 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.
* @return A Java Future containing the result of the DeleteGroup operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.DeleteGroup
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteGroupAsync(DeleteGroupRequest deleteGroupRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns information about a specified resource group.
*
*
* @param getGroupRequest
* @return A Java Future containing the result of the GetGroup operation returned by the service.
* @sample AWSResourceGroupsAsync.GetGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getGroupAsync(GetGroupRequest getGroupRequest);
/**
*
* Returns information about a specified resource group.
*
*
* @param getGroupRequest
* @param 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.
* @return A Java Future containing the result of the GetGroup operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.GetGroup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getGroupAsync(GetGroupRequest getGroupRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the resource query associated with the specified resource group.
*
*
* @param getGroupQueryRequest
* @return A Java Future containing the result of the GetGroupQuery operation returned by the service.
* @sample AWSResourceGroupsAsync.GetGroupQuery
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getGroupQueryAsync(GetGroupQueryRequest getGroupQueryRequest);
/**
*
* Returns the resource query associated with the specified resource group.
*
*
* @param getGroupQueryRequest
* @param 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.
* @return A Java Future containing the result of the GetGroupQuery operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.GetGroupQuery
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getGroupQueryAsync(GetGroupQueryRequest getGroupQueryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of tags that are associated with a resource, specified by an ARN.
*
*
* @param getTagsRequest
* @return A Java Future containing the result of the GetTags operation returned by the service.
* @sample AWSResourceGroupsAsync.GetTags
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getTagsAsync(GetTagsRequest getTagsRequest);
/**
*
* Returns a list of tags that are associated with a resource, specified by an ARN.
*
*
* @param getTagsRequest
* @param 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.
* @return A Java Future containing the result of the GetTags operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.GetTags
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getTagsAsync(GetTagsRequest getTagsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of ARNs of resources that are members of a specified resource group.
*
*
* @param listGroupResourcesRequest
* @return A Java Future containing the result of the ListGroupResources operation returned by the service.
* @sample AWSResourceGroupsAsync.ListGroupResources
* @see AWS API Documentation
*/
java.util.concurrent.Future listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest);
/**
*
* Returns a list of ARNs of resources that are members of a specified resource group.
*
*
* @param listGroupResourcesRequest
* @param 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.
* @return A Java Future containing the result of the ListGroupResources operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.ListGroupResources
* @see AWS API Documentation
*/
java.util.concurrent.Future listGroupResourcesAsync(ListGroupResourcesRequest listGroupResourcesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of existing resource groups in your account.
*
*
* @param listGroupsRequest
* @return A Java Future containing the result of the ListGroups operation returned by the service.
* @sample AWSResourceGroupsAsync.ListGroups
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listGroupsAsync(ListGroupsRequest listGroupsRequest);
/**
*
* Returns a list of existing resource groups in your account.
*
*
* @param listGroupsRequest
* @param 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.
* @return A Java Future containing the result of the ListGroups operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.ListGroups
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listGroupsAsync(ListGroupsRequest listGroupsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param searchResourcesRequest
* @return A Java Future containing the result of the SearchResources operation returned by the service.
* @sample AWSResourceGroupsAsync.SearchResources
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param searchResourcesRequest
* @param 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.
* @return A Java Future containing the result of the SearchResources operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.SearchResources
* @see AWS API Documentation
*/
java.util.concurrent.Future searchResourcesAsync(SearchResourcesRequest searchResourcesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param tagRequest
* @return A Java Future containing the result of the Tag operation returned by the service.
* @sample AWSResourceGroupsAsync.Tag
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagAsync(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.
*
*
* @param tagRequest
* @param 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.
* @return A Java Future containing the result of the Tag operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.Tag
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagAsync(TagRequest tagRequest, com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes specified tags from a specified resource.
*
*
* @param untagRequest
* @return A Java Future containing the result of the Untag operation returned by the service.
* @sample AWSResourceGroupsAsync.Untag
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagAsync(UntagRequest untagRequest);
/**
*
* Deletes specified tags from a specified resource.
*
*
* @param untagRequest
* @param 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.
* @return A Java Future containing the result of the Untag operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.Untag
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagAsync(UntagRequest untagRequest, com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates an existing group with a new or changed description. You cannot update the name of a resource group.
*
*
* @param updateGroupRequest
* @return A Java Future containing the result of the UpdateGroup operation returned by the service.
* @sample AWSResourceGroupsAsync.UpdateGroup
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateGroupAsync(UpdateGroupRequest updateGroupRequest);
/**
*
* Updates an existing group with a new or changed description. You cannot update the name of a resource group.
*
*
* @param updateGroupRequest
* @param 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.
* @return A Java Future containing the result of the UpdateGroup operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.UpdateGroup
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateGroupAsync(UpdateGroupRequest updateGroupRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the resource query of a group.
*
*
* @param updateGroupQueryRequest
* @return A Java Future containing the result of the UpdateGroupQuery operation returned by the service.
* @sample AWSResourceGroupsAsync.UpdateGroupQuery
* @see AWS API Documentation
*/
java.util.concurrent.Future updateGroupQueryAsync(UpdateGroupQueryRequest updateGroupQueryRequest);
/**
*
* Updates the resource query of a group.
*
*
* @param updateGroupQueryRequest
* @param 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.
* @return A Java Future containing the result of the UpdateGroupQuery operation returned by the service.
* @sample AWSResourceGroupsAsyncHandler.UpdateGroupQuery
* @see AWS API Documentation
*/
java.util.concurrent.Future updateGroupQueryAsync(UpdateGroupQueryRequest updateGroupQueryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}