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

StartTraceRetrieval

Initiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group. For more information, see Transaction Search.

API returns a RetrievalToken, which can be used with ListRetrievedTraces or GetRetrievedTracesGraph to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled.

For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces.

Request Syntax


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

{
   "EndTime": number,
   "StartTime": number,
   "TraceIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

EndTime

The end of the time range to retrieve traces. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Type: Timestamp

Required: Yes

StartTime

The start of the time range to retrieve traces. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Type: Timestamp

Required: Yes

TraceIds

Specify the trace IDs of the traces to be retrieved.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "RetrievalToken": "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.

RetrievalToken

Retrieval token.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1020.

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