Amazon X-Ray · Schema

ErrorRootCauseEntity

A collection of segments and corresponding subsegments associated to a trace summary error.

Application PerformanceDebuggingDistributed TracingMonitoringObservability

Properties

Name Type Description
Name object
Exceptions object
Remote object
View JSON Schema on GitHub

JSON Schema

xray-error-root-cause-entity-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the entity."
        }
      ]
    },
    "Exceptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RootCauseExceptions"
        },
        {
          "description": "The types and messages of the exceptions."
        }
      ]
    },
    "Remote": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableBoolean"
        },
        {
          "description": "A flag that denotes a remote subsegment."
        }
      ]
    }
  },
  "description": "A collection of segments and corresponding subsegments associated to a trace summary error.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ErrorRootCauseEntity",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-schema/xray-error-root-cause-entity-schema.json"
}