UpdateFleetMetric - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric action.

Request Syntax

PATCH /fleet-metric/metricName HTTP/1.1 Content-type: application/json { "aggregationField": "string", "aggregationType": { "name": "string", "values": [ "string" ] }, "description": "string", "expectedVersion": number, "indexName": "string", "period": number, "queryString": "string", "queryVersion": "string", "unit": "string" }

URI Request Parameters

The request uses the following URI parameters.


The name of the fleet metric to update.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_\-\.]+

Required: Yes

Request Body

The request accepts the following data in JSON format.


The field to aggregate.

Type: String

Length Constraints: Minimum length of 1.

Required: No


The type of the aggregation query.

Type: AggregationType object

Required: No


The description of the fleet metric.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [\p{Graph}\x20]*

Required: No


The expected version of the fleet metric record in the registry.

Type: Long

Required: No


The name of the index to search.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9:_-]+

Required: Yes


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

Type: Integer

Valid Range: Minimum value of 60. Maximum value of 86400.

Required: No


The search query string.

Type: String

Length Constraints: Minimum length of 1.

Required: No


The version of the query.

Type: String

Required: No


Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

Type: String

Valid Values: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.



The index is not ready.

HTTP Status Code: 400


An unexpected error has occurred.

HTTP Status Code: 500


The aggregation is invalid.

HTTP Status Code: 400


The query is invalid.

HTTP Status Code: 400


The request is not valid.

HTTP Status Code: 400


The specified resource does not exist.

HTTP Status Code: 404


The service is temporarily unavailable.

HTTP Status Code: 503


The rate exceeds the limit.

HTTP Status Code: 400


You are not authorized to perform this operation.

HTTP Status Code: 401


An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

HTTP Status Code: 409

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: