Sign in

v1

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

Describes one or more of your network insights analyses.

get/#Action=DescribeNetworkInsightsAnalyses

Query parameters

NetworkInsightsAnalysisIdstring[]

The ID of the network insights analyses. You must specify either analysis IDs or a path ID.

NetworkInsightsPathIdstring

The ID of the path. You must specify either a path ID or analysis IDs.

AnalysisStartTimestring date-time

The time when the network insights analyses started.

AnalysisEndTimestring date-time

The time when the network insights analyses ended.

Namestring

The name of the filter. Filter names are case-sensitive.

Valuesstring[]

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values.

<p>The filters. The following are the possible values:</p> <ul> <li> <p>path-found - A Boolean value that indicates whether a feasible path is found.</p> </li> <li> <p>status - The status of the analysis (running | succeeded | failed).</p> </li> </ul>
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.

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

NextTokenstring

The token for the next page of results.

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

Response

Success