ListTagsForResource
Displays the tags associated with a canary or group.
Request Syntax
GET /tags/resourceArn
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- resourceArn
-
The ARN of the canary or group that you want to view tags for.
The ARN format of a canary is
arn:aws:synthetics:Region:account-id:canary:canary-name
.The ARN format of a group is
arn:aws:synthetics:Region:account-id:group:group-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|group):[0-9a-z_\-]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Tags": {
"string" : "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Tags
-
The list of tag keys and values associated with the resource that you specified.
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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The request was not valid.
HTTP Status Code: 400
- ConflictException
-
A conflicting operation is already in progress.
HTTP Status Code: 409
- InternalFailureException
-
An internal failure occurred. Try the operation again.
HTTP Status Code: 500
- NotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- TooManyRequestsException
-
There were too many simultaneous requests. Try the operation again.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: