custom_metrics_list_only
Lists custom_metrics
in a region or regions, for all properties use custom_metrics
Overview
Name | custom_metrics_list_only |
Type | Resource |
Description | A custom metric published by your devices to Device Defender. |
Id | aws.iot.custom_metrics_list_only |
Fields
Name | Datatype | Description |
---|---|---|
metric_name | string | The 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_name | string | Field 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_type | string | The type of the custom metric. Types include string-list, ip-address-list, number-list, and number. |
metric_arn | string | The Amazon Resource Number (ARN) of the custom metric. |
tags | array | An array of key-value pairs to apply to this resource. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
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