ListTags
Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.
Request Syntax
GET /tags/resourceArn
/?maxResults=MaxResults
&nextToken=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
- NextToken
-
The next item following a partial list of returned items. For example, if a request is made to return
MaxResults
number of items,NextToken
allows you to return more items in your list starting at the location pointed to by the next token. - resourceArn
-
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for
ListTags
are recovery points, backup plans, and backup vaults.Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"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.
- NextToken
-
The next item following a partial list of returned items. For example, if a request is made to return
MaxResults
number of items,NextToken
allows you to return more items in your list starting at the location pointed to by the next token.Type: String
- Tags
-
Information about the tags.
Type: String to string map
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
- 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 Amazon SDKs, see the following: