MetricDataResult

A GetMetricData call returns an array of MetricDataResult structures.

AlarmsAwsDashboardsLogsMetricsMonitoringObservability

Properties

Name	Type	Description
Id	string	The short name you specified to represent this metric.
Label	string	The human-readable label associated with the data.
Timestamps	array	The timestamps for the data points, formatted in Unix epoch time.
Values	array	The data points for the metric corresponding to Timestamps.
StatusCode	string	The status of the returned data.
Messages	array	A list of messages with additional information about the data returned.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MetricDataResult",
  "title": "MetricDataResult",
  "type": "object",
  "description": "A GetMetricData call returns an array of MetricDataResult structures.",
  "properties": {
    "Id": {
      "type": "string",
      "description": "The short name you specified to represent this metric.",
      "example": "abc123"
    },
    "Label": {
      "type": "string",
      "description": "The human-readable label associated with the data.",
      "example": "Example Title"
    },
    "Timestamps": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "date-time"
      },
      "description": "The timestamps for the data points, formatted in Unix epoch time.",
      "example": []
    },
    "Values": {
      "type": "array",
      "items": {
        "type": "number",
        "format": "double"
      },
      "description": "The data points for the metric corresponding to Timestamps.",
      "example": []
    },
    "StatusCode": {
      "type": "string",
      "enum": [
        "Complete",
        "InternalError",
        "Forbidden",
        "PartialData"
      ],
      "description": "The status of the returned data.",
      "example": "Complete"
    },
    "Messages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MessageData"
      },
      "description": "A list of messages with additional information about the data returned.",
      "example": []
    }
  }
}