com.amazonaws.services.resourcegroups.AWSResourceGroups 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.resourcegroups.model.*;
/**
* Interface for accessing Resource Groups.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.resourcegroups.AbstractAWSResourceGroups} 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 AWSResourceGroups {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "resource-groups";
/**
*
* Creates a group with a specified name, description, and resource query.
*
*
* @param createGroupRequest
* @return Result of the CreateGroup operation returned by the service.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.CreateGroup
* @see AWS
* API Documentation
*/
CreateGroupResult createGroup(CreateGroupRequest createGroupRequest);
/**
*
* 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 Result of the DeleteGroup operation returned by the service.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws NotFoundException
* One or more resources specified in the request do not exist.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.DeleteGroup
* @see AWS
* API Documentation
*/
DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest);
/**
*
* Returns information about a specified resource group.
*
*
* @param getGroupRequest
* @return Result of the GetGroup operation returned by the service.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws NotFoundException
* One or more resources specified in the request do not exist.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.GetGroup
* @see AWS API
* Documentation
*/
GetGroupResult getGroup(GetGroupRequest getGroupRequest);
/**
*
* Returns the resource query associated with the specified resource group.
*
*
* @param getGroupQueryRequest
* @return Result of the GetGroupQuery operation returned by the service.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws NotFoundException
* One or more resources specified in the request do not exist.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.GetGroupQuery
* @see AWS
* API Documentation
*/
GetGroupQueryResult getGroupQuery(GetGroupQueryRequest getGroupQueryRequest);
/**
*
* Returns a list of tags that are associated with a resource, specified by an ARN.
*
*
* @param getTagsRequest
* @return Result of the GetTags operation returned by the service.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws NotFoundException
* One or more resources specified in the request do not exist.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.GetTags
* @see AWS API
* Documentation
*/
GetTagsResult getTags(GetTagsRequest getTagsRequest);
/**
*
* Returns a list of ARNs of resources that are members of a specified resource group.
*
*
* @param listGroupResourcesRequest
* @return Result of the ListGroupResources operation returned by the service.
* @throws UnauthorizedException
* The request has not been applied because it lacks valid authentication credentials for the target
* resource.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws NotFoundException
* One or more resources specified in the request do not exist.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.ListGroupResources
* @see AWS API Documentation
*/
ListGroupResourcesResult listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest);
/**
*
* Returns a list of existing resource groups in your account.
*
*
* @param listGroupsRequest
* @return Result of the ListGroups operation returned by the service.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.ListGroups
* @see AWS API
* Documentation
*/
ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest);
/**
*
* 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 Result of the SearchResources operation returned by the service.
* @throws UnauthorizedException
* The request has not been applied because it lacks valid authentication credentials for the target
* resource.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.SearchResources
* @see AWS API Documentation
*/
SearchResourcesResult searchResources(SearchResourcesRequest searchResourcesRequest);
/**
*
* 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 Result of the Tag operation returned by the service.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws NotFoundException
* One or more resources specified in the request do not exist.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.Tag
* @see AWS API
* Documentation
*/
TagResult tag(TagRequest tagRequest);
/**
*
* Deletes specified tags from a specified resource.
*
*
* @param untagRequest
* @return Result of the Untag operation returned by the service.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws NotFoundException
* One or more resources specified in the request do not exist.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.Untag
* @see AWS API
* Documentation
*/
UntagResult untag(UntagRequest untagRequest);
/**
*
* Updates an existing group with a new or changed description. You cannot update the name of a resource group.
*
*
* @param updateGroupRequest
* @return Result of the UpdateGroup operation returned by the service.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws NotFoundException
* One or more resources specified in the request do not exist.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.UpdateGroup
* @see AWS
* API Documentation
*/
UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest);
/**
*
* Updates the resource query of a group.
*
*
* @param updateGroupQueryRequest
* @return Result of the UpdateGroupQuery operation returned by the service.
* @throws BadRequestException
* The request does not comply with validation rules that are defined for the request parameters.
* @throws ForbiddenException
* The caller is not authorized to make the request.
* @throws NotFoundException
* One or more resources specified in the request do not exist.
* @throws MethodNotAllowedException
* The request uses an HTTP method which is not allowed for the specified resource.
* @throws TooManyRequestsException
* The caller has exceeded throttling limits.
* @throws InternalServerErrorException
* An internal error occurred while processing the request.
* @sample AWSResourceGroups.UpdateGroupQuery
* @see AWS API Documentation
*/
UpdateGroupQueryResult updateGroupQuery(UpdateGroupQueryRequest updateGroupQueryRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}