POST /#Action=DescribeNetworkInsightsAnalyses

Describes one or more of your network insights analyses.

Servers

Request headers

Name Type Required Description
X-Amz-Content-Sha256 String No
X-Amz-Credential String No
Content-Type String Yes The media type of the request body.

Default value: "text/xml"

X-Amz-Date String No
X-Amz-Algorithm String No
X-Amz-SignedHeaders String No
X-Amz-Security-Token String No
X-Amz-Signature String No

Query parameters

Name Type Required Description
Version String Yes

Possible values:

  • "2016-11-15"
MaxResults String No

Pagination limit

NextToken String No

Pagination token

Action String Yes

Possible values:

  • "DescribeNetworkInsightsAnalyses"

Request body fields

Name Type Required Description
NetworkInsightsPathId String No

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

MaxResults Integer No

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

AnalysisEndTime String No

The time when the network insights analyses ended.

AnalysisStartTime String No

The time when the network insights analyses started.

Filters[] Array No

The filters. The following are the possible values:

  • path-found - A Boolean value that indicates whether a feasible path is found.

  • status - The status of the analysis (running | succeeded | failed).

NextToken String No

The token for the next page of results.

NetworkInsightsAnalysisIds[] Array No

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

DryRun Boolean No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.