StartNetworkInsightsAnalysis - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

StartNetworkInsightsAnalysis

Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Type: String

Required: Yes

DryRun

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.

Type: Boolean

Required: No

FilterInArn.N

The Amazon Resource Names (ARN) of the resources that the path must traverse.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 1283.

Required: No

NetworkInsightsPathId

The ID of the path.

Type: String

Required: Yes

TagSpecification.N

The tags to apply.

Type: Array of TagSpecification objects

Required: No

Response Elements

The following elements are returned by the service.

networkInsightsAnalysis

Information about the network insights analysis.

Type: NetworkInsightsAnalysis object

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: