BatchGetTraces - Amazon X-Ray
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.

Request Syntax

POST /Traces HTTP/1.1 Content-type: application/json { "NextToken": "string", "TraceIds": [ "string" ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


Pagination token.

Type: String

Required: No


Specify the trace IDs of requests for which to retrieve segments.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Traces": [ { "Duration": number, "Id": "string", "LimitExceeded": boolean, "Segments": [ { "Document": "string", "Id": "string" } ] } ], "UnprocessedTraceIds": [ "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.


Pagination token.

Type: String


Full traces for the specified requests.

Type: Array of Trace objects


Trace IDs of requests that haven't been processed.

Type: Array of strings

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


For information about the errors that are common to all actions, see Common Errors.


The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400


The request exceeds the maximum number of requests per second.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: