AbstractAWSResourceGroupsTaggingAPI (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.resourcegroupstaggingapi.AbstractAWSResourceGroupsTaggingAPI

All Implemented Interfaces:

AWSResourceGroupsTaggingAPI

Direct Known Subclasses:

AbstractAWSResourceGroupsTaggingAPIAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSResourceGroupsTaggingAPI
extends Object
implements AWSResourceGroupsTaggingAPI
```
Abstract implementation of AWSResourceGroupsTaggingAPI. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.resourcegroupstaggingapi.AWSResourceGroupsTaggingAPI
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`GetResourcesResult`	`getResources(GetResourcesRequest request)` Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account.
`GetTagKeysResult`	`getTagKeys(GetTagKeysRequest request)` Returns all tag keys in the specified region for the AWS account.
`GetTagValuesResult`	`getTagValues(GetTagValuesRequest request)` Returns all tag values for the specified key in the specified region for the AWS account.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourcesResult`	`tagResources(TagResourcesRequest request)` Applies one or more tags to the specified resources.
`UntagResourcesResult`	`untagResources(UntagResourcesRequest request)` Removes the specified tags from the specified resources.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getResources
```
public GetResourcesResult getResources(GetResourcesRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    
    Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.
    
    Specified by:
    
    getResources in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the GetResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTagKeys
```
public GetTagKeysResult getTagKeys(GetTagKeysRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    
    Returns all tag keys in the specified region for the AWS account.
    
    Specified by:
    
    getTagKeys in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the GetTagKeys operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTagValues
```
public GetTagValuesResult getTagValues(GetTagValuesRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    
    Returns all tag values for the specified key in the specified region for the AWS account.
    
    Specified by:
    
    getTagValues in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the GetTagValues operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResources
```
public TagResourcesResult tagResources(TagResourcesRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    Applies one or more tags to the specified resources. Note the following:
    - Not all resources can have tags. For a list of resources that support tagging, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide.
    - Each resource can have up to 50 tags. For other limits, see Tag Restrictions in the Amazon EC2 User Guide for Linux Instances.
    - You can only tag resources that are located in the specified region for the AWS account.
    - To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.
    Specified by:
    
    tagResources in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the TagResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResources
```
public UntagResourcesResult untagResources(UntagResourcesRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:
    - To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.
    - You can only tag resources that are located in the specified region for the AWS account.
    Specified by:
    
    untagResources in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the UntagResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    
    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.
    
    Specified by:
    
    shutdown in interface AWSResourceGroupsTaggingAPI
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSResourceGroupsTaggingAPI
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSResourceGroupsTaggingAPI

Field Summary

Fields inherited from interface com.amazonaws.services.resourcegroupstaggingapi.AWSResourceGroupsTaggingAPI

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getResources

getTagKeys

getTagValues

tagResources

untagResources

shutdown

getCachedResponseMetadata