com.amazonaws.services.resourcegroupstaggingapi

Interface AWSResourceGroupsTaggingAPIAsync

All Superinterfaces:

AWSResourceGroupsTaggingAPI

All Known Implementing Classes:

AbstractAWSResourceGroupsTaggingAPIAsync, AWSResourceGroupsTaggingAPIAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSResourceGroupsTaggingAPIAsync
extends AWSResourceGroupsTaggingAPI

Interface 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.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSResourceGroupsTaggingAPIAsync instead.

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 use resource groups tagging API operations, you must add the following permissions to your IAM policy:

• tag:GetResources

• tag:TagResources

• tag:UntagResources

• tag:GetTagKeys

• tag:GetTagValues

You'll also need permissions to access the resources of individual services so that you can tag and untag those resources.

For more information on IAM policies, see Managing IAM Policies in the IAM User Guide.

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

• Alexa for Business (a4b)

• API Gateway

• Amazon AppStream

• AWS AppSync

• AWS App Mesh

• Amazon Athena

• Amazon Aurora

• AWS Backup

• 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 CodeCommit

• AWS CodePipeline

• AWS CodeStar

• Amazon Cognito Identity

• Amazon Cognito User Pools

• Amazon Comprehend

• AWS Config

• AWS Data Exchange

• AWS Data Pipeline

• AWS Database Migration Service

• AWS DataSync

• AWS Device Farm

• AWS Direct Connect

• AWS Directory Service

• Amazon DynamoDB

• Amazon EBS

• Amazon EC2

• Amazon ECR

• Amazon ECS

• Amazon EKS

• 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 S3 Glacier

• AWS Glue

• Amazon GuardDuty

• Amazon Inspector

• AWS IoT Analytics

• AWS IoT Core

• AWS IoT Device Defender

• AWS IoT Device Management

• AWS IoT Events

• AWS IoT Greengrass

• AWS IoT 1-Click

• 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

• AWS Organizations

• Amazon Quantum Ledger Database (QLDB)

• 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 Security Hub

• AWS Service Catalog

• Amazon Simple Notification Service (SNS)

• Amazon Simple Queue Service (SQS)

• Amazon Simple Workflow Service

• AWS Step Functions

• AWS Storage Gateway

• AWS Systems Manager

• AWS Transfer for SFTP

• Amazon VPC

• Amazon WorkSpaces

Field Summary

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<DescribeReportCreationResult>	describeReportCreationAsync(DescribeReportCreationRequest describeReportCreationRequest) Describes the status of the StartReportCreation operation.
Future<DescribeReportCreationResult>	describeReportCreationAsync(DescribeReportCreationRequest describeReportCreationRequest, AsyncHandler<DescribeReportCreationRequest,DescribeReportCreationResult> asyncHandler) Describes the status of the StartReportCreation operation.
Future<GetComplianceSummaryResult>	getComplianceSummaryAsync(GetComplianceSummaryRequest getComplianceSummaryRequest) Returns a table that shows counts of resources that are noncompliant with their tag policies.
Future<GetComplianceSummaryResult>	getComplianceSummaryAsync(GetComplianceSummaryRequest getComplianceSummaryRequest, AsyncHandler<GetComplianceSummaryRequest,GetComplianceSummaryResult> asyncHandler) Returns a table that shows counts of resources that are noncompliant with their tag policies.
Future<GetResourcesResult>	getResourcesAsync(GetResourcesRequest getResourcesRequest) Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
Future<GetResourcesResult>	getResourcesAsync(GetResourcesRequest getResourcesRequest, 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 getTagKeysRequest) Returns all tag keys in the specified Region for the AWS account.
Future<GetTagKeysResult>	getTagKeysAsync(GetTagKeysRequest getTagKeysRequest, AsyncHandler<GetTagKeysRequest,GetTagKeysResult> asyncHandler) Returns all tag keys in the specified Region for the AWS account.
Future<GetTagValuesResult>	getTagValuesAsync(GetTagValuesRequest getTagValuesRequest) Returns all tag values for the specified key in the specified Region for the AWS account.
Future<GetTagValuesResult>	getTagValuesAsync(GetTagValuesRequest getTagValuesRequest, AsyncHandler<GetTagValuesRequest,GetTagValuesResult> asyncHandler) Returns all tag values for the specified key in the specified Region for the AWS account.
Future<StartReportCreationResult>	startReportCreationAsync(StartReportCreationRequest startReportCreationRequest) Generates a report that lists all tagged resources in accounts across your organization and tells whether each resource is compliant with the effective tag policy.
Future<StartReportCreationResult>	startReportCreationAsync(StartReportCreationRequest startReportCreationRequest, AsyncHandler<StartReportCreationRequest,StartReportCreationResult> asyncHandler) Generates a report that lists all tagged resources in accounts across your organization and tells whether each resource is compliant with the effective tag policy.
Future<TagResourcesResult>	tagResourcesAsync(TagResourcesRequest tagResourcesRequest) Applies one or more tags to the specified resources.
Future<TagResourcesResult>	tagResourcesAsync(TagResourcesRequest tagResourcesRequest, AsyncHandler<TagResourcesRequest,TagResourcesResult> asyncHandler) Applies one or more tags to the specified resources.
Future<UntagResourcesResult>	untagResourcesAsync(UntagResourcesRequest untagResourcesRequest) Removes the specified tags from the specified resources.
Future<UntagResourcesResult>	untagResourcesAsync(UntagResourcesRequest untagResourcesRequest, AsyncHandler<UntagResourcesRequest,UntagResourcesResult> asyncHandler) Removes the specified tags from the specified resources.

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

describeReportCreation, getCachedResponseMetadata, getComplianceSummary, getResources, getTagKeys, getTagValues, shutdown, startReportCreation, tagResources, untagResources

Method Detail

describeReportCreationAsync

Future<DescribeReportCreationResult> describeReportCreationAsync(DescribeReportCreationRequest describeReportCreationRequest)

Describes the status of the StartReportCreation operation.

You can call this operation only from the organization's master account and from the us-east-1 Region.

Parameters:

describeReportCreationRequest -

Returns:

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

See Also:

AWS API Documentation

describeReportCreationAsync

Future<DescribeReportCreationResult> describeReportCreationAsync(DescribeReportCreationRequest describeReportCreationRequest,
                                                                 AsyncHandler<DescribeReportCreationRequest,DescribeReportCreationResult> asyncHandler)

Describes the status of the StartReportCreation operation.

You can call this operation only from the organization's master account and from the us-east-1 Region.

Parameters:

describeReportCreationRequest -

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 DescribeReportCreation operation returned by the service.

See Also:

AWS API Documentation

getComplianceSummaryAsync

Future<GetComplianceSummaryResult> getComplianceSummaryAsync(GetComplianceSummaryRequest getComplianceSummaryRequest)

Returns a table that shows counts of resources that are noncompliant with their tag policies.

For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.

You can call this operation only from the organization's master account and from the us-east-1 Region.

Parameters:

getComplianceSummaryRequest -

Returns:

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

See Also:

AWS API Documentation

getComplianceSummaryAsync

Future<GetComplianceSummaryResult> getComplianceSummaryAsync(GetComplianceSummaryRequest getComplianceSummaryRequest,
                                                             AsyncHandler<GetComplianceSummaryRequest,GetComplianceSummaryResult> asyncHandler)

Returns a table that shows counts of resources that are noncompliant with their tag policies.

For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.

You can call this operation only from the organization's master account and from the us-east-1 Region.

Parameters:

getComplianceSummaryRequest -

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 GetComplianceSummary operation returned by the service.

See Also:

AWS API Documentation

getResourcesAsync

Future<GetResourcesResult> getResourcesAsync(GetResourcesRequest getResourcesRequest)

Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.

Depending on what information you want returned, you can also specify the following:

• Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.

• Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.

You can check the PaginationToken response parameter to determine if a query is complete. Queries 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.

Parameters:

getResourcesRequest -

Returns:

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

See Also:

AWS API Documentation

getResourcesAsync

Future<GetResourcesResult> getResourcesAsync(GetResourcesRequest getResourcesRequest,
                                             AsyncHandler<GetResourcesRequest,GetResourcesResult> asyncHandler)

Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.

Depending on what information you want returned, you can also specify the following:

• Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.

• Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.

You can check the PaginationToken response parameter to determine if a query is complete. Queries 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.

Parameters:

getResourcesRequest -

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

Future<GetTagKeysResult> getTagKeysAsync(GetTagKeysRequest getTagKeysRequest)

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

Parameters:

getTagKeysRequest -

Returns:

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

See Also:

AWS API Documentation

getTagKeysAsync

Future<GetTagKeysResult> getTagKeysAsync(GetTagKeysRequest getTagKeysRequest,
                                         AsyncHandler<GetTagKeysRequest,GetTagKeysResult> asyncHandler)

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

Parameters:

getTagKeysRequest -

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

Future<GetTagValuesResult> getTagValuesAsync(GetTagValuesRequest getTagValuesRequest)

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

Parameters:

getTagValuesRequest -

Returns:

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

See Also:

AWS API Documentation

getTagValuesAsync

Future<GetTagValuesResult> getTagValuesAsync(GetTagValuesRequest getTagValuesRequest,
                                             AsyncHandler<GetTagValuesRequest,GetTagValuesResult> asyncHandler)

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

Parameters:

getTagValuesRequest -

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

startReportCreationAsync

Future<StartReportCreationResult> startReportCreationAsync(StartReportCreationRequest startReportCreationRequest)

Generates a report that lists all tagged resources in accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily.

The generated report is saved to the following location:

s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv

You can call this operation only from the organization's master account and from the us-east-1 Region.

Parameters:

startReportCreationRequest -

Returns:

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

See Also:

AWS API Documentation

startReportCreationAsync

Future<StartReportCreationResult> startReportCreationAsync(StartReportCreationRequest startReportCreationRequest,
                                                           AsyncHandler<StartReportCreationRequest,StartReportCreationResult> asyncHandler)

Generates a report that lists all tagged resources in accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily.

The generated report is saved to the following location:

s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv

You can call this operation only from the organization's master account and from the us-east-1 Region.

Parameters:

startReportCreationRequest -

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 StartReportCreation operation returned by the service.

See Also:

AWS API Documentation

tagResourcesAsync

Future<TagResourcesResult> tagResourcesAsync(TagResourcesRequest tagResourcesRequest)

Applies one or more tags to the specified resources. Note the following:

• Not all resources can have tags. For a list of services that support tagging, see this list.

• Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.

• 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 this list.

Parameters:

tagResourcesRequest -

Returns:

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

See Also:

AWS API Documentation

tagResourcesAsync

Future<TagResourcesResult> tagResourcesAsync(TagResourcesRequest tagResourcesRequest,
                                             AsyncHandler<TagResourcesRequest,TagResourcesResult> asyncHandler)

Applies one or more tags to the specified resources. Note the following:

• Not all resources can have tags. For a list of services that support tagging, see this list.

• Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.

• 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 this list.

Parameters:

tagResourcesRequest -

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

Future<UntagResourcesResult> untagResourcesAsync(UntagResourcesRequest untagResourcesRequest)

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 this list.

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

Parameters:

untagResourcesRequest -

Returns:

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

See Also:

AWS API Documentation

untagResourcesAsync

Future<UntagResourcesResult> untagResourcesAsync(UntagResourcesRequest untagResourcesRequest,
                                                 AsyncHandler<UntagResourcesRequest,UntagResourcesResult> asyncHandler)

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 this list.

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

Parameters:

untagResourcesRequest -

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