{ "opencollection": "1.0.0", "info": { "name": "AWS IoT Accept Certificate Transfer Custom Metric API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Custom Metric", "type": "folder" }, "items": [ { "info": { "name": "Amazon IoT Core Describe Custom Metric", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/custom-metric/:metricName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "metricName", "value": "", "type": "path", "description": " The name of the custom metric. " } ] }, "docs": "
Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
" }, { "info": { "name": "Amazon IoT Core Create Custom Metric", "type": "http" }, "http": { "method": "POST", "url": "http://iot.{region}.amazonaws.com/custom-metric/:metricName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "metricName", "value": "", "type": "path", "description": " The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin withaws:. You can't change the name after you define it."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
" }, { "info": { "name": "Amazon IoT Core Update Custom Metric", "type": "http" }, "http": { "method": "PATCH", "url": "http://iot.{region}.amazonaws.com/custom-metric/:metricName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "metricName", "value": "", "type": "path", "description": " The name of the custom metric. Cannot be updated. " } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
" }, { "info": { "name": "Amazon IoT Core Delete Custom Metric", "type": "http" }, "http": { "method": "DELETE", "url": "http://iot.{region}.amazonaws.com/custom-metric/:metricName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "metricName", "value": "", "type": "path", "description": " The name of the custom metric. " } ] }, "docs": "Deletes a Device Defender detect custom metric.
Requires permission to access the DeleteCustomMetric action.
Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the