Amazon IoT Device Management · JSON Structure

Iot Device Management Metric To Retain Structure

The metric you want to retain. Dimensions are optional.

Type: object Properties: 2 Required: 1
Device ManagementFleet ManagementIoTOTA Updates

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

Properties

metric metricDimension

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-iot-device-management/refs/heads/main/json-structure/iot-device-management-metric-to-retain-structure.json",
  "name": "MetricToRetain",
  "description": "The metric you want to retain. Dimensions are optional.",
  "type": "object",
  "properties": {
    "metric": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BehaviorMetric"
        },
        {
          "description": "What is measured by the behavior."
        }
      ]
    },
    "metricDimension": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricDimension"
        },
        {
          "description": "The dimension of a metric. This can't be used with custom metrics."
        }
      ]
    }
  },
  "required": [
    "metric"
  ]
}