/fleet-metric/{metricName}

Creates a fleet metric.

Requires permission to access the CreateFleetMetric action.

curl --location -g --request PUT '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", "tags": [ { "Key": "string", "Value": "string" } ] }'

Request

Path Params

metricName

string

required

The name of the fleet metric to create.

Body Params application/json

queryString

string

required

The search query string.

>= 1 characters

aggregationType

object

required

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

required

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

required

The field to aggregate.

>= 1 characters

description

string

optional

The fleet metric description.

<= 1024 characters

Match pattern:

[\p{Graph}\x20]*

queryVersion

string

optional

The query version.

indexName

string

optional

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. Default to null.

Allowed values:

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

Request

Responses