# ListRetrievedTraces
<a name="API_ListRetrievedTraces"></a>

 Retrieves a list of traces for a given `RetrievalToken` from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see [BatchGetTraces](https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html). 

This API does not initiate a retrieval process. To start a trace retrieval, use `StartTraceRetrieval`, which generates the required `RetrievalToken`.

 When the `RetrievalStatus` is not *COMPLETE*, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces.

For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is set as the destination across relevant accounts. For more details, see [CloudWatch cross-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html).

For retrieving data from X-Ray directly as opposed to the Transaction Search generated log group, see [BatchGetTraces](https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html).

## Request Syntax
<a name="API_ListRetrievedTraces_RequestSyntax"></a>

```
POST /ListRetrievedTraces HTTP/1.1
Content-type: application/json

{
   "NextToken": "string",
   "RetrievalToken": "string",
   "TraceFormat": "string"
}
```

## URI Request Parameters
<a name="API_ListRetrievedTraces_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListRetrievedTraces_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NextToken](#API_ListRetrievedTraces_RequestSyntax) **   <a name="xray-ListRetrievedTraces-request-NextToken"></a>
 Specify the pagination token returned by a previous request to retrieve the next page of indexes.   
Type: String  
Required: No

 ** [RetrievalToken](#API_ListRetrievedTraces_RequestSyntax) **   <a name="xray-ListRetrievedTraces-request-RetrievalToken"></a>
 Retrieval token.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1020.  
Required: Yes

 ** [TraceFormat](#API_ListRetrievedTraces_RequestSyntax) **   <a name="xray-ListRetrievedTraces-request-TraceFormat"></a>
 Format of the requested traces.   
Type: String  
Valid Values: `XRAY | OTEL`   
Required: No

## Response Syntax
<a name="API_ListRetrievedTraces_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RetrievalStatus": "string",
   "TraceFormat": "string",
   "Traces": [ 
      { 
         "Duration": number,
         "Id": "string",
         "Spans": [ 
            { 
               "Document": "string",
               "Id": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_ListRetrievedTraces_ResponseElements"></a>

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](#API_ListRetrievedTraces_ResponseSyntax) **   <a name="xray-ListRetrievedTraces-response-NextToken"></a>
 Specify the pagination token returned by a previous request to retrieve the next page of indexes.   
Type: String

 ** [RetrievalStatus](#API_ListRetrievedTraces_ResponseSyntax) **   <a name="xray-ListRetrievedTraces-response-RetrievalStatus"></a>
 Status of the retrieval.   
Type: String  
Valid Values: `SCHEDULED | RUNNING | COMPLETE | FAILED | CANCELLED | TIMEOUT` 

 ** [TraceFormat](#API_ListRetrievedTraces_ResponseSyntax) **   <a name="xray-ListRetrievedTraces-response-TraceFormat"></a>
 Format of the requested traces.   
Type: String  
Valid Values: `XRAY | OTEL` 

 ** [Traces](#API_ListRetrievedTraces_ResponseSyntax) **   <a name="xray-ListRetrievedTraces-response-Traces"></a>
 Full traces for the specified requests.   
Type: Array of [RetrievedTrace](API_RetrievedTrace.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

## Errors
<a name="API_ListRetrievedTraces_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListRetrievedTraces_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/ListRetrievedTraces)