com.amazonaws.services.resourcegroups

Class AWSResourceGroupsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.resourcegroups.AWSResourceGroupsClient

All Implemented Interfaces:

AWSResourceGroups

Direct Known Subclasses:

AWSResourceGroupsAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSResourceGroupsClient
extends AmazonWebServiceClient
implements AWSResourceGroups

Client for accessing Resource Groups. All service calls made using this client are blocking, and will not return until the service call completes.

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 class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSResourceGroupsClientBuilder	builder()
CreateGroupResult	createGroup(CreateGroupRequest request) Creates a group with a specified name, description, and resource query.
DeleteGroupResult	deleteGroup(DeleteGroupRequest request) 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 request) Returns information about a specified resource group.
GetGroupQueryResult	getGroupQuery(GetGroupQueryRequest request) Returns the resource query associated with the specified resource group.
GetTagsResult	getTags(GetTagsRequest request) Returns a list of tags that are associated with a resource, specified by an ARN.
ListGroupResourcesResult	listGroupResources(ListGroupResourcesRequest request) Returns a list of ARNs of resources that are members of a specified resource group.
ListGroupsResult	listGroups(ListGroupsRequest request) Returns a list of existing resource groups in your account.
SearchResourcesResult	searchResources(SearchResourcesRequest request) Returns a list of AWS resource identifiers that matches a specified query.
TagResult	tag(TagRequest request) Adds specified tags to a resource with the specified ARN.
UntagResult	untag(UntagRequest request) Deletes specified tags from a specified resource.
UpdateGroupResult	updateGroup(UpdateGroupRequest request) Updates an existing group with a new or changed description.
UpdateGroupQueryResult	updateGroupQuery(UpdateGroupQueryRequest request) Updates the resource query of a group.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

shutdown

Method Detail

builder

public static AWSResourceGroupsClientBuilder builder()

createGroup

public CreateGroupResult createGroup(CreateGroupRequest request)

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

Specified by:

createGroup in interface AWSResourceGroups

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

public DeleteGroupResult deleteGroup(DeleteGroupRequest request)

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.

Specified by:

deleteGroup in interface AWSResourceGroups

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

public GetGroupResult getGroup(GetGroupRequest request)

Returns information about a specified resource group.

Specified by:

getGroup in interface AWSResourceGroups

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

public GetGroupQueryResult getGroupQuery(GetGroupQueryRequest request)

Returns the resource query associated with the specified resource group.

Specified by:

getGroupQuery in interface AWSResourceGroups

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

public GetTagsResult getTags(GetTagsRequest request)

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

Specified by:

getTags in interface AWSResourceGroups

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

public ListGroupResourcesResult listGroupResources(ListGroupResourcesRequest request)

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

Specified by:

listGroupResources in interface AWSResourceGroups

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

public ListGroupsResult listGroups(ListGroupsRequest request)

Returns a list of existing resource groups in your account.

Specified by:

listGroups in interface AWSResourceGroups

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

public SearchResourcesResult searchResources(SearchResourcesRequest request)

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.

Specified by:

searchResources in interface AWSResourceGroups

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

public TagResult tag(TagRequest request)

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.

Specified by:

tag in interface AWSResourceGroups

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

public UntagResult untag(UntagRequest request)

Deletes specified tags from a specified resource.

Specified by:

untag in interface AWSResourceGroups

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

public UpdateGroupResult updateGroup(UpdateGroupRequest request)

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

Specified by:

updateGroup in interface AWSResourceGroups

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

public UpdateGroupQueryResult updateGroupQuery(UpdateGroupQueryRequest request)

Updates the resource query of a group.

Specified by:

updateGroupQuery in interface AWSResourceGroups

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSResourceGroups

Parameters:

request - The originally executed request

Returns:

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