Amazon X-Ray · JSON Structure

Xray Get Trace Summaries Request Structure

GetTraceSummariesRequest schema from Amazon X-Ray API

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

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

Properties

StartTime EndTime TimeRangeType Sampling SamplingStrategy FilterExpression NextToken

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

JSON Structure

Raw ↑
{
  "type": "object",
  "required": [
    "StartTime",
    "EndTime"
  ],
  "name": "GetTraceSummariesRequest",
  "properties": {
    "StartTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The start of the time frame for which to retrieve traces."
        }
      ]
    },
    "EndTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The end of the time frame for which to retrieve traces."
        }
      ]
    },
    "TimeRangeType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeRangeType"
        },
        {
          "description": "A parameter to indicate whether to query trace summaries by TraceId or Event time."
        }
      ]
    },
    "Sampling": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableBoolean"
        },
        {
          "description": "Set to <code>true</code> to get summaries for only a subset of available traces."
        }
      ]
    },
    "SamplingStrategy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SamplingStrategy"
        },
        {
          "description": "A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value."
        }
      ]
    },
    "FilterExpression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterExpression"
        },
        {
          "description": "Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements."
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Specify the pagination token returned by a previous request to retrieve the next page of results."
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-structure/xray-get-trace-summaries-request-structure.json",
  "description": "GetTraceSummariesRequest schema from Amazon X-Ray API"
}