TagResource
Adds one or more tags to an Athena resource. A tag is a label that you
assign to a resource. In Athena, a resource can be a workgroup or data
catalog. Each tag consists of a key and an optional value, both of which you define. For
example, you can use tags to categorize Athena workgroups or data catalogs
by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to
search and filter workgroups or data catalogs in your account. For best practices, see
Tagging Best Practices
Request Syntax
{
"ResourceARN": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ResourceARN
-
Specifies the ARN of the Athena resource (workgroup or data catalog) to which tags are to be added.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
- Tags
-
A collection of one or more tags, separated by commas, to be added to an Athena workgroup or data catalog resource.
Type: Array of Tag objects
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
Indicates a platform issue, which may be due to a transient condition or outage.
HTTP Status Code: 500
- InvalidRequestException
-
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource, such as a workgroup, was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: