ListTagsForResource
Returns a list of all tags associated with a specified dashboard resource.
Request Syntax
{
"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.
- resourceArn
-
The unique identifier for the resource.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:(dashboard|scheduled-report)/(\*|[-a-z0-9]+)Required: Yes
Response Syntax
{
"resourceTags": [
{
"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.
- resourceTags
-
The list of tags associated with the specified dashboard resource.
Type: Array of ResourceTag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InternalServerException
-
An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Support.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
HTTP Status Code: 400
- ValidationException
-
The input parameters do not satisfy the requirements. Check the error message for specific validation details.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: