Skip to content

Batch Get Traces

xray_batch_get_traces R Documentation

Retrieves a list of traces specified by ID

Description

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

Usage

xray_batch_get_traces(TraceIds, NextToken)

Arguments

TraceIds

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

NextToken

Pagination token.

Value

A list with the following syntax:

list(
  Traces = list(
    list(
      Id = "string",
      Duration = 123.0,
      LimitExceeded = TRUE|FALSE,
      Segments = list(
        list(
          Id = "string",
          Document = "string"
        )
      )
    )
  ),
  UnprocessedTraceIds = list(
    "string"
  ),
  NextToken = "string"
)

Request syntax

svc$batch_get_traces(
  TraceIds = list(
    "string"
  ),
  NextToken = "string"
)