Amazon IoT Core · Schema
DescribeCustomMetricResponse
DescribeCustomMetricResponse schema
Device ManagementIoTMQTTMessage Routing
Properties
| Name | Type | Description |
|---|---|---|
| metricName | object | |
| metricArn | object | |
| metricType | object | |
| displayName | object | |
| creationDate | object | |
| lastModifiedDate | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-core/refs/heads/main/json-schema/iot-core-describe-custom-metric-response-schema.json",
"title": "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. "
}
]
}
}
}