Amazon CodeGuru Profiler · JSON Structure

Amazon Codeguru Profiler Batch Get Frame Metric Data Response Structure

The structure representing the BatchGetFrameMetricDataResponse.

Type: object Properties: 6 Required: 6
AmazonApplication PerformanceProfilingDevOpsMachine Learning

BatchGetFrameMetricDataResponse is a JSON Structure definition published by Amazon CodeGuru Profiler, describing 6 properties, of which 6 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

endTime endTimes frameMetricData resolution startTime unprocessedEndTimes

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeguru-profiler/refs/heads/main/json-structure/amazon-codeguru-profiler-batch-get-frame-metric-data-response-structure.json",
  "name": "BatchGetFrameMetricDataResponse",
  "description": "The structure representing the BatchGetFrameMetricDataResponse.",
  "type": "object",
  "properties": {
    "endTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": " The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. "
        }
      ]
    },
    "endTimes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfTimestamps"
        },
        {
          "description": " List of instances, or time steps, in the time series. For example, if the <code>period</code> is one day (<code>PT24H)</code>), and the <code>resolution</code> is five minutes (<code>PT5M</code>), then there are 288 <code>endTimes</code> in the list that are each five minutes appart. "
        }
      ]
    },
    "frameMetricData": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FrameMetricData"
        },
        {
          "description": "Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame."
        }
      ]
    },
    "resolution": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AggregationPeriod"
        },
        {
          "description": "<p>Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values. </p> <ul> <li> <p> <code>P1D</code> \u2014 1 day </p> </li> <li> <p> <code>PT1H</code> \u2014 1 hour </p> </li> <li> <p> <code>PT5M</code> \u2014 5 minutes </p> </li> </ul>"
        }
      ]
    },
    "startTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": " The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. "
        }
      ]
    },
    "unprocessedEndTimes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UnprocessedEndTimeMap"
        },
        {
          "description": "List of instances which remained unprocessed. This will create a missing time step in the list of end times."
        }
      ]
    }
  },
  "required": [
    "endTime",
    "endTimes",
    "frameMetricData",
    "resolution",
    "startTime",
    "unprocessedEndTimes"
  ]
}