Amazon IoT Device Management · JSON Structure

Iot Device Management Describe Custom Metric Response Structure

DescribeCustomMetricResponse schema

Type: object Properties: 6
Device ManagementFleet ManagementIoTOTA Updates

DescribeCustomMetricResponse is a JSON Structure definition published by Amazon IoT Device Management, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

metricName metricArn metricType displayName creationDate lastModifiedDate

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-describe-custom-metric-response-structure.json",
  "name": "DescribeCustomMetricResponse",
  "description": "DescribeCustomMetricResponse schema",
  "type": "object",
  "properties": {
    "metricName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricName"
        },
        {
          "description": " The name of the custom metric. "
        }
      ]
    },
    "metricArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomMetricArn"
        },
        {
          "description": " The Amazon Resource Number (ARN) of the custom metric. "
        }
      ]
    },
    "metricType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomMetricType"
        },
        {
          "description": "<p> The type of the custom metric. </p> <important> <p>The type <code>number</code> only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.</p> </important>"
        }
      ]
    },
    "displayName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomMetricDisplayName"
        },
        {
          "description": " Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated. "
        }
      ]
    },
    "creationDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": " The creation date of the custom metric in milliseconds since epoch. "
        }
      ]
    },
    "lastModifiedDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": " The time the custom metric was last modified in milliseconds since epoch. "
        }
      ]
    }
  }
}