fleet_metric
Gets an individual fleet_metric
resource
Overview
Name | fleet_metric |
Type | Resource |
Description | fleet_metric |
Id | awscc.iot.fleet_metric |
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 | |
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
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