Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142381,278956.3 KB

Creates a fleet metric.

Requires permission to access the CreateFleetMetric action.

put/fleet-metric/{metricName}

Path parameters

metricNamestring required

The name of the fleet metric to create.

Request body

queryStringstring required

The search query string.

periodinteger required

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

aggregationFieldstring required

The field to aggregate.

descriptionstring

The fleet metric description.

queryVersionstring

The query version.

indexNamestring

The name of the index to search.

unit'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'

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.

Response

Success

metricNamestring

The name of the fleet metric to create.

metricArnstring

The Amazon Resource Name (ARN) of the new fleet metric.