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 resource group with the specified name and description.
DeleteGroupResult	deleteGroup(DeleteGroupRequest deleteGroupRequest) Deletes the 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.
GetGroupConfigurationResult	getGroupConfiguration(GetGroupConfigurationRequest getGroupConfigurationRequest) Returns the service configuration associated with the specified resource group.
GetGroupQueryResult	getGroupQuery(GetGroupQueryRequest getGroupQueryRequest) Retrieves 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.
GroupResourcesResult	groupResources(GroupResourcesRequest groupResourcesRequest) Adds the specified resources to the specified group.
ListGroupResourcesResult	listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest) Returns a list of ARNs of the 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 tne 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.
UngroupResourcesResult	ungroupResources(UngroupResourcesRequest ungroupResourcesRequest) Removes the specified resources from the specified group.
UntagResult	untag(UntagRequest untagRequest) Deletes tags from a specified resource group.
UpdateGroupResult	updateGroup(UpdateGroupRequest updateGroupRequest) Updates the description for an existing group.
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 resource group with the specified name and description. You can optionally include a resource query, or a service configuration.

Parameters:

createGroupRequest -

Returns:

Result of the CreateGroup operation returned by the service.

Throws:

BadRequestException - The request includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

See Also:

AWS API Documentation

deleteGroup

DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)

Deletes the specified resource group. Deleting a resource group does not delete any 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 includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

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 includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

See Also:

AWS API Documentation

getGroupConfiguration

GetGroupConfigurationResult getGroupConfiguration(GetGroupConfigurationRequest getGroupConfigurationRequest)

Returns the service configuration associated with the specified resource group. AWS Resource Groups supports configurations for the following resource group types:

• AWS::EC2::CapacityReservationPool - Amazon EC2 capacity reservation pools. For more information, see Working with capacity reservation groups in the EC2 Users Guide.

Parameters:

getGroupConfigurationRequest -

Returns:

Result of the GetGroupConfiguration operation returned by the service.

Throws:

BadRequestException - The request includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

See Also:

AWS API Documentation

getGroupQuery

GetGroupQueryResult getGroupQuery(GetGroupQueryRequest getGroupQueryRequest)

Retrieves 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 includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

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 includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

See Also:

AWS API Documentation

groupResources

GroupResourcesResult groupResources(GroupResourcesRequest groupResourcesRequest)

Adds the specified resources to the specified group.

Parameters:

groupResourcesRequest -

Returns:

Result of the GroupResources operation returned by the service.

Throws:

BadRequestException - The request includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

See Also:

AWS API Documentation

listGroupResources

ListGroupResourcesResult listGroupResources(ListGroupResourcesRequest listGroupResourcesRequest)

Returns a list of ARNs of the 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 was rejected because it doesn't have valid credentials for the target resource.

BadRequestException - The request includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

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 includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

See Also:

AWS API Documentation

searchResources

SearchResourcesResult searchResources(SearchResourcesRequest searchResourcesRequest)

Returns a list of AWS resource identifiers that matches tne 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 was rejected because it doesn't have valid credentials for the target resource.

BadRequestException - The request includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

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.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Parameters:

tagRequest -

Returns:

Result of the Tag operation returned by the service.

Throws:

BadRequestException - The request includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

See Also:

AWS API Documentation

ungroupResources

UngroupResourcesResult ungroupResources(UngroupResourcesRequest ungroupResourcesRequest)

Removes the specified resources from the specified group.

Parameters:

ungroupResourcesRequest -

Returns:

Result of the UngroupResources operation returned by the service.

Throws:

BadRequestException - The request includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

See Also:

AWS API Documentation

untag

UntagResult untag(UntagRequest untagRequest)

Deletes tags from a specified resource group.

Parameters:

untagRequest -

Returns:

Result of the Untag operation returned by the service.

Throws:

BadRequestException - The request includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

See Also:

AWS API Documentation

updateGroup

UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest)

Updates the description for an existing group. 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 includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

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 includes one or more parameters that violate validation rules.

ForbiddenException - The caller isn't authorized to make the request. Check permissions.

NotFoundException - One or more of the specified resources don't exist.

MethodNotAllowedException - The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException - You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException - An internal error occurred while processing the request. Try again later.

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.