com.amazonaws.services.resourcegroups

Interface AWSResourceGroups

All Known Subinterfaces:

AWSResourceGroupsAsync

All Known Implementing Classes:

AbstractAWSResourceGroups, AbstractAWSResourceGroupsAsync, AWSResourceGroupsAsyncClient, AWSResourceGroupsClient

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

Interface for accessing Resource Groups.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from 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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateGroupResult	createGroup(CreateGroupRequest createGroupRequest) Creates a group with a specified name, description, and resource query.
DeleteGroupResult	deleteGroup(DeleteGroupRequest deleteGroupRequest) Deletes a specified resource group.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetGroupResult	getGroup(GetGroupRequest getGroupRequest) Returns information about a specified resource group.
GetGroupQueryResult	getGroupQuery(GetGroupQueryRequest getGroupQueryRequest) Returns the resource query associated with the specified resource group.
GetTagsResult	getTags(GetTagsRequest getTagsRequest) Returns a list of tags that are associated with a resource group, specified by an ARN.
ListGroupResourcesResult	listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest) Returns a list of ARNs of resources that are members of a specified resource group.
ListGroupsResult	listGroups(ListGroupsRequest listGroupsRequest) Returns a list of existing resource groups in your account.
SearchResourcesResult	searchResources(SearchResourcesRequest searchResourcesRequest) Returns a list of AWS resource identifiers that matches a specified query.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResult	tag(TagRequest tagRequest) Adds tags to a resource group with the specified ARN.
UntagResult	untag(UntagRequest untagRequest) Deletes specified tags from a specified resource.
UpdateGroupResult	updateGroup(UpdateGroupRequest updateGroupRequest) Updates an existing group with a new or changed description.
UpdateGroupQueryResult	updateGroupQuery(UpdateGroupQueryRequest updateGroupQueryRequest) Updates the resource query of a group.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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 Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createGroup

CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)

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

Parameters:

createGroupRequest -

Returns:

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.

ForbiddenException - The caller is not authorized to make the request.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

deleteGroup

DeleteGroupResult deleteGroup(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:

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.

ForbiddenException - The caller is not authorized to make the request.

NotFoundException - One or more resources specified in the request do not exist.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

getGroup

GetGroupResult getGroup(GetGroupRequest getGroupRequest)

Returns information about a specified resource group.

Parameters:

getGroupRequest -

Returns:

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.

ForbiddenException - The caller is not authorized to make the request.

NotFoundException - One or more resources specified in the request do not exist.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

getGroupQuery

GetGroupQueryResult getGroupQuery(GetGroupQueryRequest getGroupQueryRequest)

Returns the resource query associated with the specified resource group.

Parameters:

getGroupQueryRequest -

Returns:

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.

ForbiddenException - The caller is not authorized to make the request.

NotFoundException - One or more resources specified in the request do not exist.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

getTags

GetTagsResult getTags(GetTagsRequest getTagsRequest)

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

Parameters:

getTagsRequest -

Returns:

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.

ForbiddenException - The caller is not authorized to make the request.

NotFoundException - One or more resources specified in the request do not exist.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

listGroupResources

ListGroupResourcesResult listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest)

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

Parameters:

listGroupResourcesRequest -

Returns:

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.

BadRequestException - The request does not comply with validation rules that are defined for the request parameters.

ForbiddenException - The caller is not authorized to make the request.

NotFoundException - One or more resources specified in the request do not exist.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

listGroups

ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)

Returns a list of existing resource groups in your account.

Parameters:

listGroupsRequest -

Returns:

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.

ForbiddenException - The caller is not authorized to make the request.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

searchResources

SearchResourcesResult searchResources(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:

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.

BadRequestException - The request does not comply with validation rules that are defined for the request parameters.

ForbiddenException - The caller is not authorized to make the request.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

tag

TagResult tag(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:

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.

ForbiddenException - The caller is not authorized to make the request.

NotFoundException - One or more resources specified in the request do not exist.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

untag

UntagResult untag(UntagRequest untagRequest)

Deletes specified tags from a specified resource.

Parameters:

untagRequest -

Returns:

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.

ForbiddenException - The caller is not authorized to make the request.

NotFoundException - One or more resources specified in the request do not exist.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

updateGroup

UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest)

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

Parameters:

updateGroupRequest -

Returns:

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.

ForbiddenException - The caller is not authorized to make the request.

NotFoundException - One or more resources specified in the request do not exist.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

updateGroupQuery

UpdateGroupQueryResult updateGroupQuery(UpdateGroupQueryRequest updateGroupQueryRequest)

Updates the resource query of a group.

Parameters:

updateGroupQueryRequest -

Returns:

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.

ForbiddenException - The caller is not authorized to make the request.

NotFoundException - One or more resources specified in the request do not exist.

MethodNotAllowedException - The request uses an HTTP method which is not allowed for the specified resource.

TooManyRequestsException - The caller has exceeded throttling limits.

InternalServerErrorException - An internal error occurred while processing the request.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.