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 key-value pair that you can add 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.

• Configure tag policies to help maintain standardized tags across your organization's resources. For more information on tag policies, see Tag Policiesin the AWS Resource Groups User Guide.

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 Set Up Permissions in the AWS Resource Groups User Guide.

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

• Alexa for Business (a4b)

• API Gateway

• AWS AppStream

• 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 Key Management Service

• Amazon Kinesis

• 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 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 interface com.amazonaws.services.resourcegroupstaggingapi.AWSResourceGroupsTaggingAPI

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<DeleteTagPolicyResult>	deleteTagPolicyAsync(DeleteTagPolicyRequest deleteTagPolicyRequest) Deletes the policy that is attached to the specified organization root or account.
Future<DeleteTagPolicyResult>	deleteTagPolicyAsync(DeleteTagPolicyRequest deleteTagPolicyRequest, AsyncHandler<DeleteTagPolicyRequest,DeleteTagPolicyResult> asyncHandler) Deletes the policy that is attached to the specified organization root or account.
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<DisableTagPoliciesResult>	disableTagPoliciesAsync(DisableTagPoliciesRequest disableTagPoliciesRequest) Disables tag policies for your organization and deletes all tag policies.
Future<DisableTagPoliciesResult>	disableTagPoliciesAsync(DisableTagPoliciesRequest disableTagPoliciesRequest, AsyncHandler<DisableTagPoliciesRequest,DisableTagPoliciesResult> asyncHandler) Disables tag policies for your organization and deletes all tag policies.
Future<EnableTagPoliciesResult>	enableTagPoliciesAsync(EnableTagPoliciesRequest enableTagPoliciesRequest) Enables tag policies for your organization.
Future<EnableTagPoliciesResult>	enableTagPoliciesAsync(EnableTagPoliciesRequest enableTagPoliciesRequest, AsyncHandler<EnableTagPoliciesRequest,EnableTagPoliciesResult> asyncHandler) Enables tag policies for your organization.
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<GetEffectiveTagPolicyResult>	getEffectiveTagPolicyAsync(GetEffectiveTagPolicyRequest getEffectiveTagPolicyRequest) Returns the contents of the effective tag policy for the AWS account.
Future<GetEffectiveTagPolicyResult>	getEffectiveTagPolicyAsync(GetEffectiveTagPolicyRequest getEffectiveTagPolicyRequest, AsyncHandler<GetEffectiveTagPolicyRequest,GetEffectiveTagPolicyResult> asyncHandler) Returns the contents of the effective tag policy for the AWS account.
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<GetTagPolicyResult>	getTagPolicyAsync(GetTagPolicyRequest getTagPolicyRequest) Returns the policy that is attached to the specified target.
Future<GetTagPolicyResult>	getTagPolicyAsync(GetTagPolicyRequest getTagPolicyRequest, AsyncHandler<GetTagPolicyRequest,GetTagPolicyResult> asyncHandler) Returns the policy that is attached to the specified target.
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<PutTagPolicyResult>	putTagPolicyAsync(PutTagPolicyRequest putTagPolicyRequest) Validates the tag policy and then attaches it to the account or organization root.
Future<PutTagPolicyResult>	putTagPolicyAsync(PutTagPolicyRequest putTagPolicyRequest, AsyncHandler<PutTagPolicyRequest,PutTagPolicyResult> asyncHandler) Validates the tag policy and then attaches it to the account or organization root.
Future<StartReportCreationResult>	startReportCreationAsync(StartReportCreationRequest startReportCreationRequest) Generates a report that lists all tagged resources in accounts across your organization, and 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 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

deleteTagPolicy, describeReportCreation, disableTagPolicies, enableTagPolicies, getCachedResponseMetadata, getComplianceSummary, getEffectiveTagPolicy, getResources, getTagKeys, getTagPolicy, getTagValues, putTagPolicy, shutdown, startReportCreation, tagResources, untagResources

Method Detail

deleteTagPolicyAsync

Future<DeleteTagPolicyResult> deleteTagPolicyAsync(DeleteTagPolicyRequest deleteTagPolicyRequest)

Deletes the policy that is attached to the specified organization root or account.

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

Parameters:

deleteTagPolicyRequest -

Returns:

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

See Also:

AWS API Documentation

deleteTagPolicyAsync

Future<DeleteTagPolicyResult> deleteTagPolicyAsync(DeleteTagPolicyRequest deleteTagPolicyRequest,
                                                   AsyncHandler<DeleteTagPolicyRequest,DeleteTagPolicyResult> asyncHandler)

Deletes the policy that is attached to the specified organization root or account.

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

Parameters:

deleteTagPolicyRequest -

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

See Also:

AWS API Documentation

describeReportCreationAsync

Future<DescribeReportCreationResult> describeReportCreationAsync(DescribeReportCreationRequest describeReportCreationRequest)

Describes the status of the StartReportCreation operation.

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

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 from the organization's master account only and from the us-east-1 Region only.

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

disableTagPoliciesAsync

Future<DisableTagPoliciesResult> disableTagPoliciesAsync(DisableTagPoliciesRequest disableTagPoliciesRequest)

Disables tag policies for your organization and deletes all tag policies.

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

Use caution when disabling tag policies, as this is a destructive operation that applies to your entire organization. You cannot undo this operation.

Parameters:

disableTagPoliciesRequest -

Returns:

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

See Also:

AWS API Documentation

disableTagPoliciesAsync

Future<DisableTagPoliciesResult> disableTagPoliciesAsync(DisableTagPoliciesRequest disableTagPoliciesRequest,
                                                         AsyncHandler<DisableTagPoliciesRequest,DisableTagPoliciesResult> asyncHandler)

Disables tag policies for your organization and deletes all tag policies.

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

Use caution when disabling tag policies, as this is a destructive operation that applies to your entire organization. You cannot undo this operation.

Parameters:

disableTagPoliciesRequest -

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

See Also:

AWS API Documentation

enableTagPoliciesAsync

Future<EnableTagPoliciesResult> enableTagPoliciesAsync(EnableTagPoliciesRequest enableTagPoliciesRequest)

Enables tag policies for your organization. To use tag policies, you must be using AWS Organizations with all features enabled.

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

This operation does the following:

• Enables tag policies for the specified organization.

• Calls the EnableAWSServiceAccess API on your behalf to allow service access with the tagpolicies.tag.amazonaws.com service principal.

• Creates a service-linked role named AWSServiceRoleForTagPolicies.

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

Parameters:

enableTagPoliciesRequest -

Returns:

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

See Also:

AWS API Documentation

enableTagPoliciesAsync

Future<EnableTagPoliciesResult> enableTagPoliciesAsync(EnableTagPoliciesRequest enableTagPoliciesRequest,
                                                       AsyncHandler<EnableTagPoliciesRequest,EnableTagPoliciesResult> asyncHandler)

Enables tag policies for your organization. To use tag policies, you must be using AWS Organizations with all features enabled.

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

This operation does the following:

• Enables tag policies for the specified organization.

• Calls the EnableAWSServiceAccess API on your behalf to allow service access with the tagpolicies.tag.amazonaws.com service principal.

• Creates a service-linked role named AWSServiceRoleForTagPolicies.

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

Parameters:

enableTagPoliciesRequest -

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 EnableTagPolicies 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 Resource Groups User Guide.

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

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

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

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

getEffectiveTagPolicyAsync

Future<GetEffectiveTagPolicyResult> getEffectiveTagPolicyAsync(GetEffectiveTagPolicyRequest getEffectiveTagPolicyRequest)

Returns the contents of the effective tag policy for the AWS account. Depending on how you use tag policies, the effective tag policy for an account is one of the following:

• The tag policy attached to the organization that the account belongs to.

• The tag policy attached to the account.

• The combination of both policies if tag policies are attached to the organization root and account.

Parameters:

getEffectiveTagPolicyRequest -

Returns:

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

See Also:

AWS API Documentation

getEffectiveTagPolicyAsync

Future<GetEffectiveTagPolicyResult> getEffectiveTagPolicyAsync(GetEffectiveTagPolicyRequest getEffectiveTagPolicyRequest,
                                                               AsyncHandler<GetEffectiveTagPolicyRequest,GetEffectiveTagPolicyResult> asyncHandler)

Returns the contents of the effective tag policy for the AWS account. Depending on how you use tag policies, the effective tag policy for an account is one of the following:

• The tag policy attached to the organization that the account belongs to.

• The tag policy attached to the account.

• The combination of both policies if tag policies are attached to the organization root and account.

Parameters:

getEffectiveTagPolicyRequest -

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 GetEffectiveTagPolicy 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 tag policies. If supplied, the compliance check follows the specified tag policy instead of following the effective tag policy. For more information on tag policies, see Tag Policies in the AWS Resource Groups User Guide.

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.

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 tag policies. If supplied, the compliance check follows the specified tag policy instead of following the effective tag policy. For more information on tag policies, see Tag Policies in the AWS Resource Groups User Guide.

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.

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.

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.

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.

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.

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

getTagPolicyAsync

Future<GetTagPolicyResult> getTagPolicyAsync(GetTagPolicyRequest getTagPolicyRequest)

Returns the policy that is attached to the specified target.

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

Parameters:

getTagPolicyRequest -

Returns:

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

See Also:

AWS API Documentation

getTagPolicyAsync

Future<GetTagPolicyResult> getTagPolicyAsync(GetTagPolicyRequest getTagPolicyRequest,
                                             AsyncHandler<GetTagPolicyRequest,GetTagPolicyResult> asyncHandler)

Returns the policy that is attached to the specified target.

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

Parameters:

getTagPolicyRequest -

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

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.

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.

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.

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

putTagPolicyAsync

Future<PutTagPolicyResult> putTagPolicyAsync(PutTagPolicyRequest putTagPolicyRequest)

Validates the tag policy and then attaches it to the account or organization root. This policy determines whether a resource is compliant.

Validating the tag policy includes checking that the tag policy document includes the required components, uses JSON syntax, and has fewer than 5,000 characters (including spaces). For more information, see Tag Policy Structure in the AWS Resource Groups User Guide.

If you later call this operation to attach a tag policy to the same organization root or account, it overwrites the original call without prompting you to confirm.

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

Parameters:

putTagPolicyRequest -

Returns:

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

See Also:

AWS API Documentation

putTagPolicyAsync

Future<PutTagPolicyResult> putTagPolicyAsync(PutTagPolicyRequest putTagPolicyRequest,
                                             AsyncHandler<PutTagPolicyRequest,PutTagPolicyResult> asyncHandler)

Validates the tag policy and then attaches it to the account or organization root. This policy determines whether a resource is compliant.

Validating the tag policy includes checking that the tag policy document includes the required components, uses JSON syntax, and has fewer than 5,000 characters (including spaces). For more information, see Tag Policy Structure in the AWS Resource Groups User Guide.

If you later call this operation to attach a tag policy to the same organization root or account, it overwrites the original call without prompting you to confirm.

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

Parameters:

putTagPolicyRequest -

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 PutTagPolicy 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 whether each resource is compliant with the effective tag policy.

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

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 whether each resource is compliant with the effective tag policy.

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

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 resources that support tagging, see this list.

• Each resource can have up to 50 tags.

• 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 Set Up Permissions in the AWS Resource Groups User Guide.

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 resources that support tagging, see this list.

• Each resource can have up to 50 tags.

• 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 Set Up Permissions in the AWS Resource Groups User Guide.

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 Set Up Permissions in the AWS Resource Groups User Guide.

• 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 Set Up Permissions in the AWS Resource Groups User Guide.

• 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