/fleet-metric/{metricName} - AWS IoT Wireless

Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric action.

curl --location -g --request PATCH 'https://api.iotwireless.{region}.amazonaws.com/fleet-metric/' \ --header 'Content-Type: application/json' \ --data-raw '{ "queryString": "string", "aggregationType": { "name": "Statistics", "values": [] }, "period": 60, "aggregationField": "string", "description": "string", "queryVersion": "string", "indexName": "string", "unit": "Seconds", "expectedVersion": 0 }'

Request

Path Params

metricName

string

required

The name of the fleet metric to update.

Body Params application/json

queryString

string

optional

The search query string.

>= 1 characters

aggregationType

object

optional

The type of aggregation queries.

name

enum<string>

optional

The name of the aggregation type.

Allowed values:

StatisticsPercentilesCardinality

values

array[string]

optional

A list of the values of aggregation types.

period

integer

optional

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

>= 60<= 86400

aggregationField

string

optional

The field to aggregate.

>= 1 characters

description

string

optional

The description of the fleet metric.

<= 1024 characters

Match pattern:

[\p{Graph}\x20]*

queryVersion

string

optional

The version of the query.

indexName

string

required

The name of the index to search.

>= 1 characters<= 128 characters

Match pattern:

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

unit

enum<string>

optional

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

Allowed values:

SecondsMicrosecondsMillisecondsBytesKilobytesMegabytesGigabytesTerabytesBitsKilobitsMegabitsGigabitsTerabitsPercentCountBytes/SecondKilobytes/SecondMegabytes/SecondGigabytes/SecondTerabytes/SecondBits/SecondKilobits/SecondMegabits/SecondGigabits/SecondTerabits/SecondCount/SecondNone

expectedVersion

integer

optional

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

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483ServiceUnavailableException

🟠484InternalFailureException

🟠485ResourceNotFoundException

🟠486InvalidQueryException

🟠487InvalidAggregationException

🟠488VersionConflictException

🟠489IndexNotReadyException