com.amazonaws.services.resourcegroupstaggingapi

Class AWSResourceGroupsTaggingAPIClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.resourcegroupstaggingapi.AWSResourceGroupsTaggingAPIClient

All Implemented Interfaces:

AWSResourceGroupsTaggingAPI

Direct Known Subclasses:

AWSResourceGroupsTaggingAPIAsyncClient

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

Client for accessing AWS Resource Groups Tagging API. All service calls made using this client are blocking, and will not return until the service call completes.

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

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

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 AWSResourceGroupsTaggingAPIClientBuilder	builder()
DeleteTagPolicyResult	deleteTagPolicy(DeleteTagPolicyRequest request) Deletes the policy that is attached to the specified organization root or account.
DescribeReportCreationResult	describeReportCreation(DescribeReportCreationRequest request) Describes the status of the StartReportCreation operation.
DisableTagPoliciesResult	disableTagPolicies(DisableTagPoliciesRequest request) Disables tag policies for your organization and deletes all tag policies.
EnableTagPoliciesResult	enableTagPolicies(EnableTagPoliciesRequest request) Enables tag policies for your organization.
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 request) Returns a table that shows counts of resources that are noncompliant with their tag policies.
GetEffectiveTagPolicyResult	getEffectiveTagPolicy(GetEffectiveTagPolicyRequest request) Returns the contents of the effective tag policy for the AWS account.
GetResourcesResult	getResources(GetResourcesRequest request) Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
GetTagKeysResult	getTagKeys(GetTagKeysRequest request) Returns all tag keys in the specified Region for the AWS account.
GetTagPolicyResult	getTagPolicy(GetTagPolicyRequest request) Returns the policy that is attached to the specified target.
GetTagValuesResult	getTagValues(GetTagValuesRequest request) Returns all tag values for the specified key in the specified Region for the AWS account.
PutTagPolicyResult	putTagPolicy(PutTagPolicyRequest request) Validates the tag policy and then attaches it to the account or organization root.
StartReportCreationResult	startReportCreation(StartReportCreationRequest request) Generates a report that lists all tagged resources in accounts across your organization, and whether each resource is compliant with the effective tag policy.
TagResourcesResult	tagResources(TagResourcesRequest request) Applies one or more tags to the specified resources.
UntagResourcesResult	untagResources(UntagResourcesRequest request) Removes the specified tags from the specified resources.

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, shutdown, 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

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSResourceGroupsTaggingAPIClientBuilder builder()

deleteTagPolicy

public DeleteTagPolicyResult deleteTagPolicy(DeleteTagPolicyRequest request)

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.

Specified by:

deleteTagPolicy in interface AWSResourceGroupsTaggingAPI

Parameters:

deleteTagPolicyRequest -

Returns:

Result of the DeleteTagPolicy 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 as performing this operation violates a constraint.

Some of the reasons in the following list might not apply to this specific API or operation:

• Your account must be part of an organization, and you must enable all features in AWS Organizations. Set Up Permissions in the AWS Resource Groups User Guide.

• The previous report expired.

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups 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

describeReportCreation

public DescribeReportCreationResult describeReportCreation(DescribeReportCreationRequest request)

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.

Specified by:

describeReportCreation in interface AWSResourceGroupsTaggingAPI

Parameters:

describeReportCreationRequest -

Returns:

Result of the DescribeReportCreation operation returned by the service.

Throws:

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

Some of the reasons in the following list might not apply to this specific API or operation:

• Your account must be part of an organization, and you must enable all features in AWS Organizations. Set Up Permissions in the AWS Resource Groups User Guide.

• The previous report expired.

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups User Guide.

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

See Also:

AWS API Documentation

disableTagPolicies

public DisableTagPoliciesResult disableTagPolicies(DisableTagPoliciesRequest request)

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.

Specified by:

disableTagPolicies in interface AWSResourceGroupsTaggingAPI

Parameters:

disableTagPoliciesRequest -

Returns:

Result of the DisableTagPolicies 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 as performing this operation violates a constraint.

Some of the reasons in the following list might not apply to this specific API or operation:

• Your account must be part of an organization, and you must enable all features in AWS Organizations. Set Up Permissions in the AWS Resource Groups User Guide.

• The previous report expired.

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups 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

enableTagPolicies

public EnableTagPoliciesResult enableTagPolicies(EnableTagPoliciesRequest request)

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.

Specified by:

enableTagPolicies in interface AWSResourceGroupsTaggingAPI

Parameters:

enableTagPoliciesRequest -

Returns:

Result of the EnableTagPolicies 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 as performing this operation violates a constraint.

Some of the reasons in the following list might not apply to this specific API or operation:

• Your account must be part of an organization, and you must enable all features in AWS Organizations. Set Up Permissions in the AWS Resource Groups User Guide.

• The previous report expired.

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups 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

getComplianceSummary

public GetComplianceSummaryResult getComplianceSummary(GetComplianceSummaryRequest request)

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.

Specified by:

getComplianceSummary in interface AWSResourceGroupsTaggingAPI

Parameters:

getComplianceSummaryRequest -

Returns:

Result of the GetComplianceSummary operation returned by the service.

Throws:

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

Some of the reasons in the following list might not apply to this specific API or operation:

• Your account must be part of an organization, and you must enable all features in AWS Organizations. Set Up Permissions in the AWS Resource Groups User Guide.

• The previous report expired.

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups User Guide.

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

See Also:

AWS API Documentation

getEffectiveTagPolicy

public GetEffectiveTagPolicyResult getEffectiveTagPolicy(GetEffectiveTagPolicyRequest request)

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.

Specified by:

getEffectiveTagPolicy in interface AWSResourceGroupsTaggingAPI

Parameters:

getEffectiveTagPolicyRequest -

Returns:

Result of the GetEffectiveTagPolicy 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 as performing this operation violates a constraint.

Some of the reasons in the following list might not apply to this specific API or operation:

• Your account must be part of an organization, and you must enable all features in AWS Organizations. Set Up Permissions in the AWS Resource Groups User Guide.

• The previous report expired.

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups 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

getResources

public GetResourcesResult getResources(GetResourcesRequest request)

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.

Specified by:

getResources in interface AWSResourceGroupsTaggingAPI

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups 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

public GetTagKeysResult getTagKeys(GetTagKeysRequest request)

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.

Specified by:

getTagKeys in interface AWSResourceGroupsTaggingAPI

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups 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

getTagPolicy

public GetTagPolicyResult getTagPolicy(GetTagPolicyRequest request)

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.

Specified by:

getTagPolicy in interface AWSResourceGroupsTaggingAPI

Parameters:

getTagPolicyRequest -

Returns:

Result of the GetTagPolicy operation returned by the service.

Throws:

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

Some of the reasons in the following list might not apply to this specific API or operation:

• Your account must be part of an organization, and you must enable all features in AWS Organizations. Set Up Permissions in the AWS Resource Groups User Guide.

• The previous report expired.

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups 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

getTagValues

public GetTagValuesResult getTagValues(GetTagValuesRequest request)

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.

Specified by:

getTagValues in interface AWSResourceGroupsTaggingAPI

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups 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

putTagPolicy

public PutTagPolicyResult putTagPolicy(PutTagPolicyRequest request)

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.

Specified by:

putTagPolicy in interface AWSResourceGroupsTaggingAPI

Parameters:

putTagPolicyRequest -

Returns:

Result of the PutTagPolicy 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 as performing this operation violates a constraint.

Some of the reasons in the following list might not apply to this specific API or operation:

• Your account must be part of an organization, and you must enable all features in AWS Organizations. Set Up Permissions in the AWS Resource Groups User Guide.

• The previous report expired.

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups 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

startReportCreation

public StartReportCreationResult startReportCreation(StartReportCreationRequest request)

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.

Specified by:

startReportCreation in interface AWSResourceGroupsTaggingAPI

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 as performing this operation violates a constraint.

Some of the reasons in the following list might not apply to this specific API or operation:

• Your account must be part of an organization, and you must enable all features in AWS Organizations. Set Up Permissions in the AWS Resource Groups User Guide.

• The previous report expired.

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups User Guide.

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

See Also:

AWS API Documentation

tagResources

public TagResourcesResult tagResources(TagResourcesRequest request)

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.

Specified by:

tagResources in interface AWSResourceGroupsTaggingAPI

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups 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

public UntagResourcesResult untagResources(UntagResourcesRequest request)

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.

Specified by:

untagResources in interface AWSResourceGroupsTaggingAPI

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.

• There is an issue with the tag policy: It exceeds the maximum size limit, is invalid, or doesn't use JSON syntax.

• You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups 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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSResourceGroupsTaggingAPI

Parameters:

request - The originally executed request

Returns:

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