ListTagsForResource
List the tags for an App Mesh resource.
Request Syntax
GET /v20190125/tags?limit=limit
&nextToken=nextToken
&resourceArn=resourceArn
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- limit
-
The maximum number of tag results returned by
ListTagsForResource
in paginated output. When this parameter is used,ListTagsForResource
returns onlylimit
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListTagsForResource
request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter,ListTagsForResource
returns up to 100 results and anextToken
value if applicable.Valid Range: Minimum value of 1. Maximum value of 50.
- nextToken
-
The
nextToken
value returned from a previous paginatedListTagsForResource
request wherelimit
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. - resourceArn
-
The Amazon Resource Name (ARN) that identifies the resource to list the tags for.
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": [
{
"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.
- nextToken
-
The
nextToken
value to include in a futureListTagsForResource
request. When the results of aListTagsForResource
request exceedlimit
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.Type: String
-
The tags for the resource.
Type: Array of TagRef objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Errors
- BadRequestException
-
The request syntax was malformed. Check your request syntax and try again.
HTTP Status Code: 400
- ForbiddenException
-
You don't have permissions to perform this action.
HTTP Status Code: 403
- InternalServerErrorException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- NotFoundException
-
The specified resource doesn't exist. Check your request syntax and try again.
HTTP Status Code: 404
- ServiceUnavailableException
-
The request has failed due to a temporary failure of the service.
HTTP Status Code: 503
- TooManyRequestsException
-
The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: