batch_get_traces

XRay.Client.batch_get_traces(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_traces(
    TraceIds=[
        'string',
    ],
    NextToken='string'
)

Parameters

• TraceIds (list) --

  [REQUIRED]

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

  • (string) --
• NextToken (string) -- Pagination token.

Return type

dict

Returns

Response Syntax

{
    'Traces': [
        {
            'Id': 'string',
            'Duration': 123.0,
            'LimitExceeded': True|False,
            'Segments': [
                {
                    'Id': 'string',
                    'Document': 'string'
                },
            ]
        },
    ],
    'UnprocessedTraceIds': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Traces (list) --

    Full traces for the specified requests.

    • (dict) --

      A collection of segment documents with matching trace IDs.

      • Id (string) --

        The unique identifier for the request that generated the trace's segments and subsegments.

      • Duration (float) --

        The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

      • LimitExceeded (boolean) --

        LimitExceeded is set to true when the trace has exceeded the Trace document size limit. For more information about this limit and other X-Ray limits and quotas, see Amazon Web Services X-Ray endpoints and quotas.

      • Segments (list) --

        Segment documents for the segments and subsegments that comprise the trace.

        • (dict) --

          A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with PutTraceSegments, or an inferred segment for a downstream service, generated from a subsegment sent by the service that called it.

          For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide .

          • Id (string) --

            The segment's ID.

          • Document (string) --

            The segment document.

  • UnprocessedTraceIds (list) --

    Trace IDs of requests that haven't been processed.

    • (string) --

  • NextToken (string) --

    Pagination token.

Exceptions

• XRay.Client.exceptions.InvalidRequestException
• XRay.Client.exceptions.ThrottledException