Amazon X-Ray · Schema

Service

Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

Application PerformanceDebuggingDistributed TracingMonitoringObservability

Properties

Name Type Description
ReferenceId object
Name object
Names object
Root object
AccountId object
Type object
State object
StartTime object
EndTime object
Edges object
SummaryStatistics object
DurationHistogram object
ResponseTimeHistogram object
View JSON Schema on GitHub

JSON Schema

xray-service-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "ReferenceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableInteger"
        },
        {
          "description": "Identifier for the service. Unique within the service map."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The canonical name of the service."
        }
      ]
    },
    "Names": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ServiceNames"
        },
        {
          "description": "A list of names for the service, including the canonical name."
        }
      ]
    },
    "Root": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableBoolean"
        },
        {
          "description": "Indicates that the service was the first service to process a request."
        }
      ]
    },
    "AccountId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Identifier of the Amazon Web Services account in which the service runs."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "<p>The type of service.</p> <ul> <li> <p>Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, <code>AWS::EC2::Instance</code> for an application running on Amazon EC2 or <code>AWS::DynamoDB::Table</code> for an Amazon DynamoDB table that the application used.</p> </li> <li> <p>Amazon Web Services Service - The type of an Amazon Web Services service. For example, <code>AWS::DynamoDB</code> for downstream calls to Amazon DynamoDB that didn't target a specific table.</p> </li> <li> <p> <code>client</code> - Represents the clients that sent requests to a root service.</p> </li> <li> <p> <code>remote</code> - A downstream service of indeterminate type.</p> </li> </ul>"
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The service's state."
        }
      ]
    },
    "StartTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The start time of the first segment that the service generated."
        }
      ]
    },
    "EndTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The end time of the last segment that the service generated."
        }
      ]
    },
    "Edges": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EdgeList"
        },
        {
          "description": "Connections to downstream services."
        }
      ]
    },
    "SummaryStatistics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ServiceStatistics"
        },
        {
          "description": "Aggregated statistics for the service."
        }
      ]
    },
    "DurationHistogram": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Histogram"
        },
        {
          "description": "A histogram that maps the spread of service durations."
        }
      ]
    },
    "ResponseTimeHistogram": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Histogram"
        },
        {
          "description": "A histogram that maps the spread of service response times."
        }
      ]
    }
  },
  "description": "Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Service",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-schema/xray-service-schema.json"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/xray-service"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.