custom_metric

Gets an individual custom_metric resource

Overview

Name	custom_metric
Type	Resource
Description	custom_metric
Id	awscc.iot.custom_metric

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

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
metric_name,
display_name,
metric_type,
metric_arn,
tags
FROM awscc.iot.custom_metric
WHERE data__Identifier = '<MetricName>';

Permissions

To operate on the custom_metric resource, the following permissions are required:

Read

iot:DescribeCustomMetric,
iot:ListTagsForResource

Update

iot:UpdateCustomMetric,
iot:ListTagsForResource,
iot:UntagResource,
iot:TagResource

Delete

iot:DescribeCustomMetric,
iot:DeleteCustomMetric