com.amazonaws.services.resourcegroupstaggingapi

Interface AWSResourceGroupsTaggingAPI

All Known Subinterfaces:

AWSResourceGroupsTaggingAPIAsync

All Known Implementing Classes:

AbstractAWSResourceGroupsTaggingAPI, AbstractAWSResourceGroupsTaggingAPIAsync, AWSResourceGroupsTaggingAPIAsyncClient, AWSResourceGroupsTaggingAPIClient

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

Interface for accessing AWS Resource Groups Tagging API.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSResourceGroupsTaggingAPI 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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
DescribeReportCreationResult	describeReportCreation(DescribeReportCreationRequest describeReportCreationRequest) Describes the status of the StartReportCreation operation.
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.
GetComplianceSummaryResult	getComplianceSummary(GetComplianceSummaryRequest getComplianceSummaryRequest) Returns a table that shows counts of resources that are noncompliant with their tag policies.
GetResourcesResult	getResources(GetResourcesRequest getResourcesRequest) Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
GetTagKeysResult	getTagKeys(GetTagKeysRequest getTagKeysRequest) Returns all tag keys in the specified Region for the AWS account.
GetTagValuesResult	getTagValues(GetTagValuesRequest getTagValuesRequest) 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.
StartReportCreationResult	startReportCreation(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.
TagResourcesResult	tagResources(TagResourcesRequest tagResourcesRequest) Applies one or more tags to the specified resources.
UntagResourcesResult	untagResources(UntagResourcesRequest untagResourcesRequest) Removes the specified tags from the specified resources.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

describeReportCreation

DescribeReportCreationResult describeReportCreation(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:

Result of the DescribeReportCreation operation returned by the service.

Throws:

ConstraintViolationException - The request was denied because performing this operation violates a constraint.

Some of the reasons in the following list might not apply to this specific operation.

• You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the AWS Organizations User Guide.

• You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com) to integrate with AWS Organizations For information, see EnableAWSServiceAccess.

• You must have a tag policy attached to the organization root, an OU, or an account.

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

InvalidParameterException - This error indicates one of the following:

• A parameter is missing.

• A malformed string was supplied for the request parameter.

• An out-of-range value was supplied for the request parameter.

• The target ID is invalid, unsupported, or doesn't exist.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.

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

See Also:

AWS API Documentation

getComplianceSummary

GetComplianceSummaryResult getComplianceSummary(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:

Result of the GetComplianceSummary operation returned by the service.

Throws:

ConstraintViolationException - The request was denied because performing this operation violates a constraint.

Some of the reasons in the following list might not apply to this specific operation.

• You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the AWS Organizations User Guide.

• You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com) to integrate with AWS Organizations For information, see EnableAWSServiceAccess.

• You must have a tag policy attached to the organization root, an OU, or an account.

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

InvalidParameterException - This error indicates one of the following:

• A parameter is missing.

• A malformed string was supplied for the request parameter.

• An out-of-range value was supplied for the request parameter.

• The target ID is invalid, unsupported, or doesn't exist.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.

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

See Also:

AWS API Documentation

getResources

GetResourcesResult getResources(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:

Result of the GetResources operation returned by the service.

Throws:

InvalidParameterException - This error indicates one of the following:

• A parameter is missing.

• A malformed string was supplied for the request parameter.

• An out-of-range value was supplied for the request parameter.

• The target ID is invalid, unsupported, or doesn't exist.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.

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.

See Also:

AWS API Documentation

getTagKeys

GetTagKeysResult getTagKeys(GetTagKeysRequest getTagKeysRequest)

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 - This error indicates one of the following:

• A parameter is missing.

• A malformed string was supplied for the request parameter.

• An out-of-range value was supplied for the request parameter.

• The target ID is invalid, unsupported, or doesn't exist.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.

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.

See Also:

AWS API Documentation

getTagValues

GetTagValuesResult getTagValues(GetTagValuesRequest getTagValuesRequest)

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 - This error indicates one of the following:

• A parameter is missing.

• A malformed string was supplied for the request parameter.

• An out-of-range value was supplied for the request parameter.

• The target ID is invalid, unsupported, or doesn't exist.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.

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.

See Also:

AWS API Documentation

startReportCreation

StartReportCreationResult startReportCreation(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:

Result of the StartReportCreation operation returned by the service.

Throws:

ConcurrentModificationException - The target of the operation is currently being modified by a different request. Try again later.

ConstraintViolationException - The request was denied because performing this operation violates a constraint.

Some of the reasons in the following list might not apply to this specific operation.

• You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the AWS Organizations User Guide.

• You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com) to integrate with AWS Organizations For information, see EnableAWSServiceAccess.

• You must have a tag policy attached to the organization root, an OU, or an account.

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

InvalidParameterException - This error indicates one of the following:

• A parameter is missing.

• A malformed string was supplied for the request parameter.

• An out-of-range value was supplied for the request parameter.

• The target ID is invalid, unsupported, or doesn't exist.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.

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

See Also:

AWS API Documentation

tagResources

TagResourcesResult tagResources(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:

Result of the TagResources operation returned by the service.

Throws:

InvalidParameterException - This error indicates one of the following:

• A parameter is missing.

• A malformed string was supplied for the request parameter.

• An out-of-range value was supplied for the request parameter.

• The target ID is invalid, unsupported, or doesn't exist.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.

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.

See Also:

AWS API Documentation

untagResources

UntagResourcesResult untagResources(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:

Result of the UntagResources operation returned by the service.

Throws:

InvalidParameterException - This error indicates one of the following:

• A parameter is missing.

• A malformed string was supplied for the request parameter.

• An out-of-range value was supplied for the request parameter.

• The target ID is invalid, unsupported, or doesn't exist.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.