AWS CLI Command Reference

[ aws . ec2 ]

get-aws-network-performance-data

Description

Gets network performance data.

See also: AWS API Documentation

get-aws-network-performance-data is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: DataResponses

Synopsis

  get-aws-network-performance-data
[--data-queries <value>]
[--start-time <value>]
[--end-time <value>]
[--dry-run | --no-dry-run]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--data-queries (list)

A list of network performance data queries.

(structure)

A query used for retrieving network health data.

Id -> (string)

A user-defined ID associated with a data query that’s returned in the dataResponse identifying the query. For example, if you set the Id to MyQuery01 in the query, the dataResponse identifies the query as MyQuery01 .

Source -> (string)

The Region or Availability Zone that’s the source for the data query. For example, us-east-1 .

Destination -> (string)

The Region or Availability Zone that’s the target for the data query. For example, eu-north-1 .

Metric -> (string)

The metric used for the network performance request.

Possible values:

  • aggregate-latency

Statistic -> (string)

The metric data aggregation period, p50 , between the specified startDate and endDate . For example, a metric of five_minutes is the median of all the data points gathered within those five minutes. p50 is the only supported metric.

Possible values:

  • p50

Period -> (string)

The aggregation period used for the data query.

Possible values:

  • five-minutes
  • fifteen-minutes
  • one-hour
  • three-hours
  • one-day
  • one-week

Shorthand Syntax: