Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot ]

create-fleet-metric

Description

Creates a fleet metric.

Requires permission to access the CreateFleetMetric action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-fleet-metric
--metric-name <value>
--query-string <value>
--aggregation-type <value>
--period <value>
--aggregation-field <value>
[--description <value>]
[--query-version <value>]
[--index-name <value>]
[--unit <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--metric-name (string)

The name of the fleet metric to create.

--query-string (string)

The search query string.

--aggregation-type (structure)

The type of the aggregation query.

name -> (string)

The name of the aggregation type.

values -> (list)

A list of the values of aggregation types.

(string)

Shorthand Syntax:

name=string,values=string,string

JSON Syntax:

{
  "name": "Statistics"|"Percentiles"|"Cardinality",
  "values": ["string", ...]
}

--period (integer)

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

--aggregation-field (string)

The field to aggregate.

--description (string)

The fleet metric description.

--query-version (string)

The query version.

--index-name (string)

The name of the index to search.

--unit (string)

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

Possible 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

--tags (list)

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

(structure)

A set of key/value pairs that are used to manage the resource.

Key -> (string)

The tag's key.

Value -> (string)

The tag's value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

metricName -> (string)

The name of the fleet metric to create.

metricArn -> (string)

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