Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-171,1822,9897.4 MB

Gets network performance data.

get/#Action=GetAwsNetworkPerformanceData

Query parameters

Idstring

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

Sourcestring

The Region or Availability Zone that's the source for the data query. For example, <code>us-east-1</code>.

Destinationstring

The Region or Availability Zone that's the target for the data query. For example, <code>eu-north-1</code>.

Metric'aggregate-latency'

The metric, <code>aggregation-latency</code>, indicating that network latency is aggregated for the query. This is the only supported metric.

Statistic'p50'

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

Period'five-minutes' | 'fifteen-minutes' | 'one-hour' | 'three-hours' | 'one-day' | 'one-week'

The aggregation period used for the data query.

A list of network performance data queries.

StartTimestring date-time

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

EndTimestring date-time

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

MaxResultsinteger

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.

NextTokenstring

The token for the next page of results.

DryRunboolean

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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

Action'GetAwsNetworkPerformanceData' required
Version'2016-11-15' required

Response

Success