TagResource
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
This API is supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.
Request Syntax
POST /tags/resourceArn
HTTP/1.1
Content-type: application/json
{
"Tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- resourceArn
-
An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
ARNs that do not include
backup
are incompatible with tagging.TagResource
andUntagResource
with invalid ARNs will result in an error. Acceptable ARN content can includearn:aws:backup:us-east
. Invalid ARN content may look likearn:aws:ec2:us-east
.Required: Yes
Request Body
The request accepts the following data in JSON format.
- Tags
-
Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags:
[{"Key":"string","Value":"string"}]
.Type: String to string map
Required: Yes
Response Syntax
HTTP/1.1 200
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.
- InvalidParameterValueException
-
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400
- LimitExceededException
-
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
HTTP Status Code: 400
- MissingParameterValueException
-
Indicates that a required parameter is missing.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource that is required for the action doesn't exist.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: