Amazon X-Ray · JSON Structure

Xray Sampling Rule Update Structure

A document specifying changes to a sampling rule's configuration.

Type: object Properties: 12
Application PerformanceDebuggingDistributed TracingMonitoringObservability

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

Properties

RuleName RuleARN ResourceARN Priority FixedRate ReservoirSize Host ServiceName ServiceType HTTPMethod URLPath Attributes

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

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "RuleName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RuleName"
        },
        {
          "description": "The name of the sampling rule. Specify a rule by either name or ARN, but not both."
        }
      ]
    },
    "RuleARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The ARN of the sampling rule. Specify a rule by either name or ARN, but not both."
        }
      ]
    },
    "ResourceARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceARN"
        },
        {
          "description": "Matches the ARN of the Amazon Web Services resource on which the service runs."
        }
      ]
    },
    "Priority": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableInteger"
        },
        {
          "description": "The priority of the sampling rule."
        }
      ]
    },
    "FixedRate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableDouble"
        },
        {
          "description": "The percentage of matching requests to instrument, after the reservoir is exhausted."
        }
      ]
    },
    "ReservoirSize": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableInteger"
        },
        {
          "description": "A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively."
        }
      ]
    },
    "Host": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Host"
        },
        {
          "description": "Matches the hostname from a request URL."
        }
      ]
    },
    "ServiceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ServiceName"
        },
        {
          "description": "Matches the <code>name</code> that the service uses to identify itself in segments."
        }
      ]
    },
    "ServiceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ServiceType"
        },
        {
          "description": "Matches the <code>origin</code> that the service uses to identify its type in segments."
        }
      ]
    },
    "HTTPMethod": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HTTPMethod"
        },
        {
          "description": "Matches the HTTP method of a request."
        }
      ]
    },
    "URLPath": {
      "allOf": [
        {
          "$ref": "#/components/schemas/URLPath"
        },
        {
          "description": "Matches the path from a request URL."
        }
      ]
    },
    "Attributes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AttributeMap"
        },
        {
          "description": "Matches attributes derived from the request."
        }
      ]
    }
  },
  "description": "A document specifying changes to a sampling rule's configuration.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "SamplingRuleUpdate",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-structure/xray-sampling-rule-update-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-rule-update-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.