Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListTagsForResource

Returns a list of tags that are applied to the specified Amazon X-Ray group or sampling rule.

Request Syntax


POST /ListTagsForResource HTTP/1.1
Content-type: application/json

{
   "NextToken": "string",
   "ResourceARN": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

NextToken

A pagination token. If multiple pages of results are returned, use the NextToken value returned with the current page of results as the value of this parameter to get the next page of results.

Type: String

Required: No

ResourceARN

The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Required: Yes

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

A pagination token. If multiple pages of results are returned, use the NextToken value returned with the current page of results to get the next page of results.

Type: String

Tags

A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.

Type: Array of Tag 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 Errors.

InvalidRequestException

The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

ResourceNotFoundException

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

HTTP Status Code: 404

ThrottledException

The request exceeds the maximum number of requests per second.

HTTP Status Code: 429