Amazon X-Ray · Schema

Segment

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.

Application PerformanceDebuggingDistributed TracingMonitoringObservability

Properties

Name Type Description
Id object
Document object
View JSON Schema on GitHub

JSON Schema

xray-segment-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SegmentId"
        },
        {
          "description": "The segment's ID."
        }
      ]
    },
    "Document": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SegmentDocument"
        },
        {
          "description": "The segment document."
        }
      ]
    }
  },
  "description": "<p>A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with <a href=\"https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html\">PutTraceSegments</a>, or an <code>inferred</code> segment for a downstream service, generated from a subsegment sent by the service that called it.</p> <p>For the full segment document schema, see <a href=\"https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html\">Amazon Web Services X-Ray Segment Documents</a> in the <i>Amazon Web Services X-Ray Developer Guide</i>.</p>",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Segment",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-schema/xray-segment-schema.json"
}