Skip to main content

custom_metrics_list_only

Lists custom_metrics in a region or regions, for all properties use custom_metrics

Overview

Namecustom_metrics_list_only
TypeResource
DescriptionA custom metric published by your devices to Device Defender.
Idaws.iot.custom_metrics_list_only

Fields

NameDatatypeDescription
metric_namestringThe name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
display_namestringField represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
metric_typestringThe type of the custom metric. Types include string-list, ip-address-list, number-list, and number.
metric_arnstringThe Amazon Resource Number (ARN) of the custom metric.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all custom_metrics in a region.

SELECT
region,
metric_name
FROM aws.iot.custom_metrics_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the custom_metrics_list_only resource, see custom_metrics