Skip to main content

custom_metric_tags

Expands all tag keys and values for custom_metrics in a region

Overview

Namecustom_metric_tags
TypeResource
DescriptionA custom metric published by your devices to Device Defender.
Idaws.iot.custom_metric_tags

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.
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all custom_metrics in a region.

SELECT
region,
metric_name,
display_name,
metric_type,
metric_arn,
tag_key,
tag_value
FROM aws.iot.custom_metric_tags
WHERE region = 'us-east-1';

Permissions

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