Amazon X-Ray · JSON Structure

Xray Annotation Value Structure

Value of a segment annotation. Has one of three value types: Number, Boolean, or String.

Type: object Properties: 3
Application PerformanceDebuggingDistributed TracingMonitoringObservability

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

Properties

NumberValue BooleanValue StringValue

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "NumberValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableDouble"
        },
        {
          "description": "Value for a Number annotation."
        }
      ]
    },
    "BooleanValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableBoolean"
        },
        {
          "description": "Value for a Boolean annotation."
        }
      ]
    },
    "StringValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Value for a String annotation."
        }
      ]
    }
  },
  "description": "Value of a segment annotation. Has one of three value types: Number, Boolean, or String.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "AnnotationValue",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-structure/xray-annotation-value-structure.json"
}