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.
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
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:
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.
Services that support the Resource Groups Tagging API
You can use the Resource Groups Tagging API to tag resources for the following AWS services.
Information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.
Information about the errors that are returned for each failed resource. This information can include
The following are common error codes that you might receive from other AWS services:
For more information on errors that are generated from other AWS services, see the documentation for that service.
A client for the AWS Resource Groups Tagging API API.
A list of resource ARNs and the tags (keys and values) that are associated with each.
A count of noncompliant resources.
The metadata that you apply to AWS resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging AWS Resources in the AWS General Reference.
A list of tags (keys and values) that are used to specify the associated resources.
Errors returned by DescribeReportCreation
Errors returned by GetComplianceSummary
Errors returned by GetResources
Errors returned by GetTagKeys
Errors returned by GetTagValues
Errors returned by StartReportCreation
Errors returned by TagResources
Errors returned by UntagResources
Trait representing the capabilities of the AWS Resource Groups Tagging API API. AWS Resource Groups Tagging API clients implement this trait.