com.amazonaws.services.resourcegroupstaggingapi

Class AWSResourceGroupsTaggingAPIAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.resourcegroupstaggingapi.AWSResourceGroupsTaggingAPIClient

com.amazonaws.services.resourcegroupstaggingapi.AWSResourceGroupsTaggingAPIAsyncClient

All Implemented Interfaces:

AWSResourceGroupsTaggingAPI, AWSResourceGroupsTaggingAPIAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSResourceGroupsTaggingAPIAsyncClient
extends AWSResourceGroupsTaggingAPIClient
implements AWSResourceGroupsTaggingAPIAsync

Client for accessing AWS Resource Groups Tagging API asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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.

You can use the resource groups tagging API operations 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

To make full use of the resource groups tagging API operations, 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 Resource Groups and Tag Editor.

You can use the Resource Groups Tagging API to tag resources for the following AWS services.

• Alexa for Business (a4b)

• API Gateway

• AWS AppStream

• AWS AppSync

• Amazon Athena

• Amazon Aurora

• AWS Certificate Manager

• AWS Certificate Manager Private CA

• Amazon Cloud Directory

• AWS CloudFormation

• Amazon CloudFront

• AWS CloudHSM

• AWS CloudTrail

• Amazon CloudWatch (alarms only)

• Amazon CloudWatch Events

• Amazon CloudWatch Logs

• AWS CodeBuild

• AWS CodeStar

• Amazon Cognito Identity

• Amazon Cognito User Pools

• Amazon Comprehend

• AWS Config

• AWS Data Pipeline

• AWS Database Migration Service

• AWS Datasync

• AWS Direct Connect

• AWS Directory Service

• Amazon DynamoDB

• Amazon EBS

• Amazon EC2

• Amazon ECR

• Amazon ECS

• AWS Elastic Beanstalk

• Amazon Elastic File System

• Elastic Load Balancing

• Amazon ElastiCache

• Amazon Elasticsearch Service

• AWS Elemental MediaLive

• AWS Elemental MediaPackage

• AWS Elemental MediaTailor

• Amazon EMR

• Amazon FSx

• Amazon Glacier

• AWS Glue

• Amazon Inspector

• AWS IoT Analytics

• AWS IoT Core

• AWS IoT Device Defender

• AWS IoT Device Management

• AWS IoT Greengrass

• AWS Key Management Service

• Amazon Kinesis

• Amazon Kinesis Data Analytics

• Amazon Kinesis Data Firehose

• AWS Lambda

• AWS License Manager

• Amazon Machine Learning

• Amazon MQ

• Amazon MSK

• Amazon Neptune

• AWS OpsWorks

• Amazon RDS

• Amazon Redshift

• AWS Resource Access Manager

• AWS Resource Groups

• AWS RoboMaker

• Amazon Route 53

• Amazon Route 53 Resolver

• Amazon S3 (buckets only)

• Amazon SageMaker

• AWS Secrets Manager

• AWS Service Catalog

• Amazon Simple Notification Service (SNS)

• Amazon Simple Queue Service (SQS)

• AWS Simple System Manager (SSM)

• AWS Step Functions

• AWS Storage Gateway

• AWS Transfer for SFTP

• Amazon VPC

• Amazon WorkSpaces

Field Summary

Fields inherited from class com.amazonaws.services.resourcegroupstaggingapi.AWSResourceGroupsTaggingAPIClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSResourceGroupsTaggingAPIAsyncClientBuilder	asyncBuilder()
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetResourcesResult>	getResourcesAsync(GetResourcesRequest request) Returns all the tagged or previously tagged resources that are located in the specified region for the AWS account.
Future<GetResourcesResult>	getResourcesAsync(GetResourcesRequest request, AsyncHandler<GetResourcesRequest,GetResourcesResult> asyncHandler) Returns all the tagged or previously tagged resources that are located in the specified region for the AWS account.
Future<GetTagKeysResult>	getTagKeysAsync(GetTagKeysRequest request) Returns all tag keys in the specified region for the AWS account.
Future<GetTagKeysResult>	getTagKeysAsync(GetTagKeysRequest request, AsyncHandler<GetTagKeysRequest,GetTagKeysResult> asyncHandler) Returns all tag keys in the specified region for the AWS account.
Future<GetTagValuesResult>	getTagValuesAsync(GetTagValuesRequest request) Returns all tag values for the specified key in the specified region for the AWS account.
Future<GetTagValuesResult>	getTagValuesAsync(GetTagValuesRequest request, AsyncHandler<GetTagValuesRequest,GetTagValuesResult> asyncHandler) Returns all tag values for the specified key in the specified region for the AWS account.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TagResourcesResult>	tagResourcesAsync(TagResourcesRequest request) Applies one or more tags to the specified resources.
Future<TagResourcesResult>	tagResourcesAsync(TagResourcesRequest request, AsyncHandler<TagResourcesRequest,TagResourcesResult> asyncHandler) Applies one or more tags to the specified resources.
Future<UntagResourcesResult>	untagResourcesAsync(UntagResourcesRequest request) Removes the specified tags from the specified resources.
Future<UntagResourcesResult>	untagResourcesAsync(UntagResourcesRequest request, AsyncHandler<UntagResourcesRequest,UntagResourcesResult> asyncHandler) Removes the specified tags from the specified resources.

Methods inherited from class com.amazonaws.services.resourcegroupstaggingapi.AWSResourceGroupsTaggingAPIClient

builder, getCachedResponseMetadata, getResources, getTagKeys, getTagValues, tagResources, untagResources

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

getCachedResponseMetadata, getResources, getTagKeys, getTagValues, tagResources, untagResources

Method Detail

asyncBuilder

public static AWSResourceGroupsTaggingAPIAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

getResourcesAsync

public Future<GetResourcesResult> getResourcesAsync(GetResourcesRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPIAsync

Returns all the tagged or previously tagged resources that are located in the specified region for the AWS account. You can optionally specify filters (tags and resource types) in your request, depending on what information you want returned. The response includes all tags that are associated with the requested resources.

You can check the PaginationToken response parameter to determine if a query completed. Queries can occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display.

Specified by:

getResourcesAsync in interface AWSResourceGroupsTaggingAPIAsync

Returns:

A Java Future containing the result of the GetResources operation returned by the service.

See Also:

AWS API Documentation

getResourcesAsync

public Future<GetResourcesResult> getResourcesAsync(GetResourcesRequest request,
                                                    AsyncHandler<GetResourcesRequest,GetResourcesResult> asyncHandler)

Description copied from interface: AWSResourceGroupsTaggingAPIAsync

Returns all the tagged or previously tagged resources that are located in the specified region for the AWS account. You can optionally specify filters (tags and resource types) in your request, depending on what information you want returned. The response includes all tags that are associated with the requested resources.

You can check the PaginationToken response parameter to determine if a query completed. Queries can occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display.

Specified by:

getResourcesAsync in interface AWSResourceGroupsTaggingAPIAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetResources operation returned by the service.

See Also:

AWS API Documentation

getTagKeysAsync

public Future<GetTagKeysResult> getTagKeysAsync(GetTagKeysRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPIAsync

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

Specified by:

getTagKeysAsync in interface AWSResourceGroupsTaggingAPIAsync

Returns:

A Java Future containing the result of the GetTagKeys operation returned by the service.

See Also:

AWS API Documentation

getTagKeysAsync

public Future<GetTagKeysResult> getTagKeysAsync(GetTagKeysRequest request,
                                                AsyncHandler<GetTagKeysRequest,GetTagKeysResult> asyncHandler)

Description copied from interface: AWSResourceGroupsTaggingAPIAsync

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

Specified by:

getTagKeysAsync in interface AWSResourceGroupsTaggingAPIAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetTagKeys operation returned by the service.

See Also:

AWS API Documentation

getTagValuesAsync

public Future<GetTagValuesResult> getTagValuesAsync(GetTagValuesRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPIAsync

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

Specified by:

getTagValuesAsync in interface AWSResourceGroupsTaggingAPIAsync

Returns:

A Java Future containing the result of the GetTagValues operation returned by the service.

See Also:

AWS API Documentation

getTagValuesAsync

public Future<GetTagValuesResult> getTagValuesAsync(GetTagValuesRequest request,
                                                    AsyncHandler<GetTagValuesRequest,GetTagValuesResult> asyncHandler)

Description copied from interface: AWSResourceGroupsTaggingAPIAsync

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

Specified by:

getTagValuesAsync in interface AWSResourceGroupsTaggingAPIAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetTagValues operation returned by the service.

See Also:

AWS API Documentation

tagResourcesAsync

public Future<TagResourcesResult> tagResourcesAsync(TagResourcesRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPIAsync

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 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 User Guide.

Specified by:

tagResourcesAsync in interface AWSResourceGroupsTaggingAPIAsync

Returns:

A Java Future containing the result of the TagResources operation returned by the service.

See Also:

AWS API Documentation

tagResourcesAsync

public Future<TagResourcesResult> tagResourcesAsync(TagResourcesRequest request,
                                                    AsyncHandler<TagResourcesRequest,TagResourcesResult> asyncHandler)

Description copied from interface: AWSResourceGroupsTaggingAPIAsync

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 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 User Guide.

Specified by:

tagResourcesAsync in interface AWSResourceGroupsTaggingAPIAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the TagResources operation returned by the service.

See Also:

AWS API Documentation

untagResourcesAsync

public Future<UntagResourcesResult> untagResourcesAsync(UntagResourcesRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPIAsync

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 User Guide.

• You can only tag resources that are located in the specified region for the AWS account.

Specified by:

untagResourcesAsync in interface AWSResourceGroupsTaggingAPIAsync

Returns:

A Java Future containing the result of the UntagResources operation returned by the service.

See Also:

AWS API Documentation

untagResourcesAsync

public Future<UntagResourcesResult> untagResourcesAsync(UntagResourcesRequest request,
                                                        AsyncHandler<UntagResourcesRequest,UntagResourcesResult> asyncHandler)

Description copied from interface: AWSResourceGroupsTaggingAPIAsync

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 User Guide.

• You can only tag resources that are located in the specified region for the AWS account.

Specified by:

untagResourcesAsync in interface AWSResourceGroupsTaggingAPIAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UntagResources operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSResourceGroupsTaggingAPI

Overrides:

shutdown in class AmazonWebServiceClient