Skip to main content

fleet_metric

Gets an individual fleet_metric resource

Overview

Namefleet_metric
TypeResource
Descriptionfleet_metric
Idawscc.iot.fleet_metric

Fields

NameDatatypeDescription
metric_namestringThe name of the fleet metric
descriptionstringThe description of a fleet metric
query_stringstringThe Fleet Indexing query used by a fleet metric
periodintegerThe period of metric emission in seconds
aggregation_fieldstringThe aggregation field to perform aggregation and metric emission
query_versionstringThe version of a Fleet Indexing query used by a fleet metric
index_namestringThe index name of a fleet metric
unitstringThe unit of data points emitted by a fleet metric
aggregation_typeobject
metric_arnstringThe Amazon Resource Number (ARN) of a fleet metric metric
creation_datestringThe creation date of a fleet metric
last_modified_datestringThe last modified date of a fleet metric
versionnumberThe version of a fleet metric
tagsarrayAn array of key-value pairs to apply to this resource
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
metric_name,
description,
query_string,
period,
aggregation_field,
query_version,
index_name,
unit,
aggregation_type,
metric_arn,
creation_date,
last_modified_date,
version,
tags
FROM awscc.iot.fleet_metric
WHERE data__Identifier = '<MetricName>';

Permissions

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

Read

iot:DescribeFleetMetric,
iot:ListTagsForResource

Update

iot:UpdateFleetMetric,
iot:DescribeFleetMetric,
iot:ListTagsForResource,
iot:UntagResource,
iot:TagResource

Delete

iot:DeleteFleetMetric,
iot:DescribeFleetMetric