Skip to content

List Retrieved Traces

xray_list_retrieved_traces R Documentation

Description

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 batch_get_traces.

This API does not initiate a retrieval job. To start a trace retrieval, use start_trace_retrieval, 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 the destination across relevant accounts. For more details, see CloudWatch cross-account observability.

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

Usage

xray_list_retrieved_traces(RetrievalToken, TraceFormat, NextToken)

Arguments

RetrievalToken

[required] Retrieval token.
TraceFormat

Format of the requested traces.
NextToken

Specify the pagination token returned by a previous request to retrieve the next page of indexes.

Value

A list with the following syntax:

list(
  RetrievalStatus = "SCHEDULED"|"RUNNING"|"COMPLETE"|"FAILED"|"CANCELLED"|"TIMEOUT",
  TraceFormat = "XRAY"|"OTEL",
  Traces = list(
    list(
      Id = "string",
      Duration = 123.0,
      Spans = list(
        list(
          Id = "string",
          Document = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_retrieved_traces(
  RetrievalToken = "string",
  TraceFormat = "XRAY"|"OTEL",
  NextToken = "string"
)