Amazon X-Ray · JSON Structure

Xray Create Sampling Rule Request Structure

CreateSamplingRuleRequest schema from Amazon X-Ray API

Type: object Properties: 2 Required: 1
Application PerformanceDebuggingDistributed TracingMonitoringObservability

CreateSamplingRuleRequest is a JSON Structure definition published by Amazon X-Ray, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

SamplingRule Tags

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "SamplingRule"
  ],
  "name": "CreateSamplingRuleRequest",
  "properties": {
    "SamplingRule": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SamplingRule"
        },
        {
          "description": "The rule definition."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "<p>A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>The following restrictions apply to tags:</p> <ul> <li> <p>Maximum number of user-applied tags per resource: 50</p> </li> <li> <p>Maximum tag key length: 128 Unicode characters</p> </li> <li> <p>Maximum tag value length: 256 Unicode characters</p> </li> <li> <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use.</p> </li> </ul>"
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-structure/xray-create-sampling-rule-request-structure.json",
  "description": "CreateSamplingRuleRequest schema from Amazon X-Ray API"
}