Amazon X-Ray · Schema

SamplingRuleUpdate

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

Application PerformanceDebuggingDistributed TracingMonitoringObservability

Properties

Name Type Description
RuleName object
RuleARN object
ResourceARN object
Priority object
FixedRate object
ReservoirSize object
Host object
ServiceName object
ServiceType object
HTTPMethod object
URLPath object
Attributes object
View JSON Schema on GitHub

JSON Schema

xray-sampling-rule-update-schema.json 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-schema.org/draft/2020-12/schema",
  "title": "SamplingRuleUpdate",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-schema/xray-sampling-rule-update-schema.json"
}