[ aws . iot ]

describe-fleet-metric

Description

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-fleet-metric
--metric-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--metric-name (string)

The name of the fleet metric to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

metricName -> (string)

The name of the fleet metric to describe.

queryString -> (string)

The search query string.

aggregationType -> (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)

period -> (integer)

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

aggregationField -> (string)

The field to aggregate.

description -> (string)

The fleet metric description.

queryVersion -> (string)

The query version.

indexName -> (string)

The name of the index to search.

creationDate -> (timestamp)

The date when the fleet metric is created.

lastModifiedDate -> (timestamp)

The date when the fleet metric is last modified.

unit -> (string)

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

version -> (long)

The version of the fleet metric.

metricArn -> (string)

The ARN of the fleet metric to describe.