fleet_metrics_list_only
Lists fleet_metrics
in a region or regions, for all properties use fleet_metrics
Overview
Name | fleet_metrics_list_only |
Type | Resource |
Description | An aggregated metric of certain devices in your fleet |
Id | aws.iot.fleet_metrics_list_only |
Fields
Name | Datatype | Description |
---|---|---|
metric_name | string | The name of the fleet metric |
description | string | The description of a fleet metric |
query_string | string | The Fleet Indexing query used by a fleet metric |
period | integer | The period of metric emission in seconds |
aggregation_field | string | The aggregation field to perform aggregation and metric emission |
query_version | string | The version of a Fleet Indexing query used by a fleet metric |
index_name | string | The index name of a fleet metric |
unit | string | The unit of data points emitted by a fleet metric |
aggregation_type | object | Aggregation types supported by Fleet Indexing |
metric_arn | string | The Amazon Resource Number (ARN) of a fleet metric metric |
creation_date | string | The creation date of a fleet metric |
last_modified_date | string | The last modified date of a fleet metric |
version | number | The version of a fleet 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 fleet_metrics
in a region.
SELECT
region,
metric_name
FROM aws.iot.fleet_metrics_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the fleet_metrics_list_only
resource, see fleet_metrics