network_insights_analysis

Creates, updates, deletes, gets or lists a network_insights_analysis resource.

Overview

Name	network_insights_analysis
Type	Resource
Id	aws.ec2.network_insights_analysis

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
delete_network_insights_analysis	delete	NetworkInsightsAnalysisId, region	DryRun	Deletes the specified network insights analysis.
start_network_insights_analysis	exec	NetworkInsightsPathId, ClientToken, region	AdditionalAccount, FilterInArn, FilterOutArn, DryRun, TagSpecification	Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ClientToken	string	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
NetworkInsightsAnalysisId	string	The ID of the network insights analysis.
NetworkInsightsPathId	string	The ID of the path.
region	string	AWS region (default: us-east-1)
AdditionalAccount	array	The member accounts that contain resources that the path can traverse.
DryRun	boolean	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.
FilterInArn	array	The Amazon Resource Names (ARN) of the resources that the path must traverse.
FilterOutArn	array	The Amazon Resource Names (ARN) of the resources that the path will ignore.
TagSpecification	array	The tags to apply.

DELETE examples

delete_network_insights_analysis

Deletes the specified network insights analysis.

DELETE FROM aws.ec2.network_insights_analysis
WHERE NetworkInsightsAnalysisId = '{{ NetworkInsightsAnalysisId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;

Lifecycle Methods

start_network_insights_analysis

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

EXEC aws.ec2.network_insights_analysis.start_network_insights_analysis 
@NetworkInsightsPathId='{{ NetworkInsightsPathId }}' --required, 
@ClientToken='{{ ClientToken }}' --required, 
@region='{{ region }}' --required, 
@AdditionalAccount='{{ AdditionalAccount }}', 
@FilterInArn='{{ FilterInArn }}', 
@FilterOutArn='{{ FilterOutArn }}', 
@DryRun={{ DryRun }}, 
@TagSpecification='{{ TagSpecification }}'
;