PUT

/fleet-metric/{metricName}

http://iot.{region}.amazonaws.com/fleet-metric/{metricName}

<p>Creates a fleet metric.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateFleetMetric</a> action.</p>

Access Token Required: API Key

Path Parameters

metricNamestringrequired

The name of the fleet metric to create.

Body Params

tagsarray

Metadata, which can be used to manage the fleet metric.

unitstring

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">CW metric</a>. Default to null.

periodintegerrequired

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

indexNamestring

The name of the index to search.

descriptionstring

The fleet metric description.

queryStringstringrequired

The search query string.

queryVersionstring

The query version.

aggregationTypeobjectrequired

The type of aggregation queries.

aggregationFieldstringrequired

The field to aggregate.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://iot.{region}.amazonaws.com/fleet-metric/{metricName}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}