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 . iotwireless ]

get-metrics

Description

Get the summary metrics for this AWS account.

See also: AWS API Documentation

Synopsis

  get-metrics
[--summary-metric-queries <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--summary-metric-queries (list)

The list of queries to retrieve the summary metrics.

(structure)

The summary metric query object.

QueryId -> (string)

The id of the summary metric query.

MetricName -> (string)

The name of the metric.

Dimensions -> (list)

The dimensions of the summary metric.

(structure)

The required list of dimensions for the metric.

name -> (string)

The name of the dimension.

value -> (string)

The dimension's value.

AggregationPeriod -> (string)

The aggregation period of the summary metric.

StartTimestamp -> (timestamp)

The start timestamp for the summary metric query.

EndTimestamp -> (timestamp)

The end timestamp for the summary metric query.

Shorthand Syntax:

QueryId=string,MetricName=string,Dimensions=[{name=string,value=string},{name=string,value=string}],AggregationPeriod=string,StartTimestamp=timestamp,EndTimestamp=timestamp ...

JSON Syntax:

[
  {
    "QueryId": "string",
    "MetricName": "DeviceRSSI"|"DeviceSNR"|"DeviceUplinkCount"|"DeviceDownlinkCount"|"DeviceUplinkLostCount"|"DeviceUplinkLostRate"|"DeviceJoinRequestCount"|"DeviceJoinAcceptCount"|"DeviceRoamingUplinkCount"|"DeviceRoamingDownlinkCount"|"GatewayUpTime"|"GatewayDownTime"|"GatewayRSSI"|"GatewaySNR"|"GatewayUplinkCount"|"GatewayDownlinkCount"|"GatewayJoinRequestCount"|"GatewayJoinAcceptCount"|"AwsAccountUplinkCount"|"AwsAccountDownlinkCount"|"AwsAccountUplinkLostCount"|"AwsAccountUplinkLostRate"|"AwsAccountJoinRequestCount"|"AwsAccountJoinAcceptCount"|"AwsAccountRoamingUplinkCount"|"AwsAccountRoamingDownlinkCount"|"AwsAccountDeviceCount"|"AwsAccountGatewayCount"|"AwsAccountActiveDeviceCount"|"AwsAccountActiveGatewayCount",
    "Dimensions": [
      {
        "name": "DeviceId"|"GatewayId",
        "value": "string"
      }
      ...
    ],
    "AggregationPeriod": "OneHour"|"OneDay"|"OneWeek",
    "StartTimestamp": timestamp,
    "EndTimestamp": timestamp
  }
  ...
]

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

SummaryMetricQueryResults -> (list)

The list of summary metrics that were retrieved.

(structure)

The result of the summary metrics aggregation operation.

QueryId -> (string)

The ID of the summary metric results query operation.

QueryStatus -> (string)

The status of the summary metric query result.

Error -> (string)

The error message for the summary metric query result.

MetricName -> (string)

The name of the summary metric query result.

Dimensions -> (list)

The dimensions of the metric.

(structure)

The required list of dimensions for the metric.

name -> (string)

The name of the dimension.

value -> (string)

The dimension's value.

AggregationPeriod -> (string)

The aggregation period of the metric.

StartTimestamp -> (timestamp)

The start timestamp for the summary metric query.

EndTimestamp -> (timestamp)

The end timestamp for the summary metric query.

Timestamps -> (list)

The timestamp of each aggregation result.

(timestamp)

Values -> (list)

The list of aggregated summary metric query results.

(structure)

The aggregated values of the metric.

Min -> (double)

The minimum of the values of all data points collected during the aggregation period.

Max -> (double)

The maximum of the values of all the data points collected during the aggregation period.

Sum -> (double)

The sum of the values of all data points collected during the aggregation period.

Avg -> (double)

The average of the values of all data points collected during the aggregation period.

Std -> (double)

The standard deviation of the values of all data points collected during the aggregation period.

P90 -> (double)

The 90th percentile of the values of all data points collected during the aggregation period.

Unit -> (string)

The units of measurement to be used for interpreting the aggregation result.