TagResource
Assigns one or more tags (key-value pairs) to the specified canary.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource
action with a canary that already has tags. If you specify a new tag key for the
alarm,
this tag is appended to the list of tags associated
with the alarm. If you specify a tag key that is already associated with the alarm,
the new tag value that you specify replaces
the previous value for that tag.
You can associate as many as 50 tags with a canary.
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
-
The ARN of the canary that you're adding tags to.
The ARN format of a canary is
arn:aws:synthetics:Region:account-id:canary:canary-name
.Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:canary:[0-9a-z_\-]{1,21}
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Tags
-
The list of key-value pairs to associate with the canary.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
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.
- InternalServerException
-
An unknown internal error occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
One of the specified resources was not found.
HTTP Status Code: 404
- ValidationException
-
A parameter could not be validated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: