SamplingTargetDocument
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.
Properties
| Name | Type | Description |
|---|---|---|
| RuleName | object | |
| FixedRate | object | |
| ReservoirQuota | object | |
| ReservoirQuotaTTL | object | |
| Interval | object |
JSON Schema
{
"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-schema.org/draft/2020-12/schema",
"title": "SamplingTargetDocument",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-schema/xray-sampling-target-document-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.
Call it yourself
curl for this page
curl "https://apis.io/api/v1/json-schemas/xray-sampling-target-document"
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.