Amazon X-Ray · JSON Structure

Xray Sampling Target Document Structure

Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.

Type: object Properties: 5
Application PerformanceDebuggingDistributed TracingMonitoringObservability

SamplingTargetDocument is a JSON Structure definition published by Amazon X-Ray, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

RuleName FixedRate ReservoirQuota ReservoirQuotaTTL Interval

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "RuleName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the sampling rule."
        }
      ]
    },
    "FixedRate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Double"
        },
        {
          "description": "The percentage of matching requests to instrument, after the reservoir is exhausted."
        }
      ]
    },
    "ReservoirQuota": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableInteger"
        },
        {
          "description": "The number of requests per second that X-Ray allocated for this service."
        }
      ]
    },
    "ReservoirQuotaTTL": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "When the reservoir quota expires."
        }
      ]
    },
    "Interval": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableInteger"
        },
        {
          "description": "The number of seconds for the service to wait before getting sampling targets again."
        }
      ]
    }
  },
  "description": "Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called <a href=\"https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html\">GetSamplingTargets</a>.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "SamplingTargetDocument",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-structure/xray-sampling-target-document-structure.json"
}

Work with this as data

Every JSON Structure 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 json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure 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 Structure
curl "https://apis.io/api/v1/json-structures/xray-sampling-target-document-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?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.