ListTagsForResource
Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.
Request Syntax
{
"Limit": number
,
"Marker": "string
",
"ResourceARN": "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.
- Limit
-
Specifies that the list of tags returned be limited to the specified number of items.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- Marker
-
An opaque string that indicates the position at which to begin returning the list of tags.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
- ResourceARN
-
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Required: Yes
Response Syntax
{
"Marker": "string",
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "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.
- Marker
-
An opaque string that indicates the position at which to stop returning the list of tags.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
- ResourceARN
-
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
- Tags
-
An array that contains the tags for the specified resource.
Type: Array of Tag objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An internal server error has occurred during the request. For more information, see the error and message fields.
HTTP Status Code: 400
- InvalidGatewayRequestException
-
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: