Skip to content

EC2  >  Operations  >  start_network_insights_analysis

start_network_insights_analysis

Operation

start_network_insights_analysis async 

start_network_insights_analysis(input: StartNetworkInsightsAnalysisInput, plugins: list[Plugin] | None = None) -> StartNetworkInsightsAnalysisOutput

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

Parameters:

Name Type Description Default
input StartNetworkInsightsAnalysisInput

An instance of StartNetworkInsightsAnalysisInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
StartNetworkInsightsAnalysisOutput

An instance of StartNetworkInsightsAnalysisOutput.

Input

StartNetworkInsightsAnalysisInput dataclass

Bases: _SerdeShape

Dataclass for StartNetworkInsightsAnalysisInput structure.

Attributes

additional_accounts class-attribute instance-attribute 
additional_accounts: list[str] | None = ...

The member accounts that contain resources that the path can traverse.

client_token class-attribute instance-attribute 
client_token: str | None = ...

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

This field is autopopulated if not provided.

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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.

filter_in_arns class-attribute instance-attribute 
filter_in_arns: list[str] | None = ...

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

filter_out_arns class-attribute instance-attribute 
filter_out_arns: list[str] | None = ...

The Amazon Resource Names (ARN) of the resources that the path will ignore.

network_insights_path_id class-attribute instance-attribute 
network_insights_path_id: str | None = ...

The ID of the path.

tag_specifications class-attribute instance-attribute 
tag_specifications: list[TagSpecification] | None = ...

The tags to apply.

Output

StartNetworkInsightsAnalysisOutput dataclass

Bases: _SerdeShape

Dataclass for StartNetworkInsightsAnalysisOutput structure.

Attributes

network_insights_analysis class-attribute instance-attribute 
network_insights_analysis: NetworkInsightsAnalysis | None = ...

Information about the network insights analysis.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.