Package software.amazon.awssdk.services.resourcegroupstaggingapi

Interface ResourceGroupsTaggingAPIClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface ResourceGroupsTaggingAPIClient
extends AutoCloseable

Service client for accessing null. This can be created using the static builder() method. Resource Groups Tagging API

This guide describes the API operations for the resource groups tagging.

A tag is a label that you assign to an AWS resource. A tag consists of a key and a value, both of which you define. For example, if you have two Amazon EC2 instances, you might assign both a tag key of "Stack." But the value of "Stack" might be "Testing" for one and "Production" for the other.

Tagging can help you organize your resources and enables you to simplify resource management, access management and cost allocation. For more information about tagging, see Working with Tag Editor and Working with Resource Groups. For more information about permissions you need to use the resource groups tagging APIs, see Obtaining Permissions for Resource Groups and Obtaining Permissions for Tagging .

You can use the resource groups tagging APIs to complete the following tasks:

• Tag and untag supported resources located in the specified region for the AWS account

• Use tag-based filters to search for resources located in the specified region for the AWS account

• List all existing tag keys in the specified region for the AWS account

• List all existing values for the specified key in the specified region for the AWS account

Not all resources can have tags. For a lists of resources that you can tag, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide.

To make full use of the resource groups tagging APIs, you might need additional IAM permissions, including permission to access the resources of individual services as well as permission to view and apply tags to those resources. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static ResourceGroupsTaggingAPIClientBuilder	builder()	Create a builder that can be used to configure and create a ResourceGroupsTaggingAPIClient.
static ResourceGroupsTaggingAPIClient	create()	Create a ResourceGroupsTaggingAPIClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetResourcesResponse	getResources(GetResourcesRequest getResourcesRequest)	Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account.
default GetTagKeysResponse	getTagKeys(GetTagKeysRequest getTagKeysRequest)	Returns all tag keys in the specified region for the AWS account.
default GetTagValuesResponse	getTagValues(GetTagValuesRequest getTagValuesRequest)	Returns all tag values for the specified key in the specified region for the AWS account.
static ServiceMetadata	serviceMetadata()
default TagResourcesResponse	tagResources(TagResourcesRequest tagResourcesRequest)	Applies one or more tags to the specified resources.
default UntagResourcesResponse	untagResources(UntagResourcesRequest untagResourcesRequest)	Removes the specified tags from the specified resources.

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static ResourceGroupsTaggingAPIClient create()

Create a ResourceGroupsTaggingAPIClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ResourceGroupsTaggingAPIClientBuilder builder()

Create a builder that can be used to configure and create a ResourceGroupsTaggingAPIClient.

getResources

default GetResourcesResponse getResources(GetResourcesRequest getResourcesRequest)
                                   throws InvalidParameterException,
                                          ThrottledException,
                                          InternalServiceException,
                                          PaginationTokenExpiredException,
                                          SdkBaseException,
                                          SdkClientException,
                                          ResourceGroupsTaggingAPIException

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.

Parameters:

getResourcesRequest -

Returns:

Result of the GetResources operation returned by the service.

Throws:

InvalidParameterException - A parameter is missing or a malformed string or invalid or out-of-range value was supplied for the request parameter.

ThrottledException - The request was denied to limit the frequency of submitted requests.

InternalServiceException - The request processing failed because of an unknown error, exception, or failure. You can retry the request.

PaginationTokenExpiredException - A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ResourceGroupsTaggingAPIException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getTagKeys

default GetTagKeysResponse getTagKeys(GetTagKeysRequest getTagKeysRequest)
                               throws InvalidParameterException,
                                      ThrottledException,
                                      InternalServiceException,
                                      PaginationTokenExpiredException,
                                      SdkBaseException,
                                      SdkClientException,
                                      ResourceGroupsTaggingAPIException

Returns all tag keys in the specified region for the AWS account.

Parameters:

getTagKeysRequest -

Returns:

Result of the GetTagKeys operation returned by the service.

Throws:

InvalidParameterException - A parameter is missing or a malformed string or invalid or out-of-range value was supplied for the request parameter.

ThrottledException - The request was denied to limit the frequency of submitted requests.

InternalServiceException - The request processing failed because of an unknown error, exception, or failure. You can retry the request.

PaginationTokenExpiredException - A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ResourceGroupsTaggingAPIException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getTagValues

default GetTagValuesResponse getTagValues(GetTagValuesRequest getTagValuesRequest)
                                   throws InvalidParameterException,
                                          ThrottledException,
                                          InternalServiceException,
                                          PaginationTokenExpiredException,
                                          SdkBaseException,
                                          SdkClientException,
                                          ResourceGroupsTaggingAPIException

Returns all tag values for the specified key in the specified region for the AWS account.

Parameters:

getTagValuesRequest -

Returns:

Result of the GetTagValues operation returned by the service.

Throws:

InvalidParameterException - A parameter is missing or a malformed string or invalid or out-of-range value was supplied for the request parameter.

ThrottledException - The request was denied to limit the frequency of submitted requests.

InternalServiceException - The request processing failed because of an unknown error, exception, or failure. You can retry the request.

PaginationTokenExpiredException - A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ResourceGroupsTaggingAPIException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

tagResources

default TagResourcesResponse tagResources(TagResourcesRequest tagResourcesRequest)
                                   throws InvalidParameterException,
                                          ThrottledException,
                                          InternalServiceException,
                                          SdkBaseException,
                                          SdkClientException,
                                          ResourceGroupsTaggingAPIException

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.

Parameters:

tagResourcesRequest -

Returns:

Result of the TagResources operation returned by the service.

Throws:

InvalidParameterException - A parameter is missing or a malformed string or invalid or out-of-range value was supplied for the request parameter.

ThrottledException - The request was denied to limit the frequency of submitted requests.

InternalServiceException - The request processing failed because of an unknown error, exception, or failure. You can retry the request.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ResourceGroupsTaggingAPIException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

untagResources

default UntagResourcesResponse untagResources(UntagResourcesRequest untagResourcesRequest)
                                       throws InvalidParameterException,
                                              ThrottledException,
                                              InternalServiceException,
                                              SdkBaseException,
                                              SdkClientException,
                                              ResourceGroupsTaggingAPIException

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.

Parameters:

untagResourcesRequest -

Returns:

Result of the UntagResources operation returned by the service.

Throws:

InvalidParameterException - A parameter is missing or a malformed string or invalid or out-of-range value was supplied for the request parameter.

ThrottledException - The request was denied to limit the frequency of submitted requests.

InternalServiceException - The request processing failed because of an unknown error, exception, or failure. You can retry the request.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ResourceGroupsTaggingAPIException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()