get-aws-network-performance-data¶

Description¶

Gets network performance data.

Synopsis¶

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

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, aggregation-latency , indicating that network latency is aggregated for the query. This is the only supported metric.

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.

Period -> (string)

The aggregation period used for the data query.

Shorthand Syntax:

Id=string,Source=string,Destination=string,Metric=string,Statistic=string,Period=string ...

JSON Syntax:

[
  {
    "Id": "string",
    "Source": "string",
    "Destination": "string",
    "Metric": "aggregate-latency",
    "Statistic": "p50",
    "Period": "five-minutes"|"fifteen-minutes"|"one-hour"|"three-hours"|"one-day"|"one-week"
  }
  ...
]

--start-time (timestamp)

The starting time for the performance data request. The starting time must be formatted as yyyy-mm-ddThh:mm:ss . For example, 2022-06-10T12:00:00.000Z .

--end-time (timestamp)

The ending time for the performance data request. The end time must be formatted as yyyy-mm-ddThh:mm:ss . For example, 2022-06-12T12:00:00.000Z .

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

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
yaml
yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

DataResponses -> (list)

The list of data responses.

(structure)

The response to a DataQuery .

Id -> (string)

The ID passed in the DataQuery .

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 destination for the data query. For example, eu-west-1 .

Metric -> (string)

The metric used for the network performance request. Only aggregate-latency is supported, which shows network latency during a specified period.

Statistic -> (string)

The statistic used for the network performance request.

Period -> (string)

The period used for the network performance request.

MetricPoints -> (list)

A list of MetricPoint objects.

(structure)

Indicates whether the network was healthy or degraded at a particular point. The value is aggregated from the startDate to the endDate . Currently only five_minutes is supported.

StartDate -> (timestamp)

The start date for the metric point. The starting date for the metric point. The starting time must be formatted as yyyy-mm-ddThh:mm:ss . For example, 2022-06-10T12:00:00.000Z .

EndDate -> (timestamp)

The end date for the metric point. The ending time must be formatted as yyyy-mm-ddThh:mm:ss . For example, 2022-06-12T12:00:00.000Z .

Value -> (float)

Status -> (string)

The status of the metric point.

NextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Table of Contents

Feedback

User Guide