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.
{
"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"
}
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.