network_insights_analyses

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

Overview

Name	network_insights_analyses
Type	Resource
Id	aws.ec2.network_insights_analyses

Fields

The following fields are returned by SELECT queries:

describe_network_insights_analyses

Name	Datatype	Description
additional_accounts	string	The member accounts that contain resources that the path can traverse.
alternate_path_hints	string	Potential intermediate components.
explanations	string	The explanations. For more information, see Reachability Analyzer explanation codes.
filter_in_arns	string	The Amazon Resource Names (ARN) of the resources that the path must traverse.
filter_out_arns	string	The Amazon Resource Names (ARN) of the resources that the path must ignore.
forward_path_components	string	The components in the path from source to destination.
network_insights_analysis_arn	string	The Amazon Resource Name (ARN) of the network insights analysis.
network_insights_analysis_id	string	The ID of the network insights analysis.
network_insights_path_id	string	The ID of the path.
network_path_found	boolean	Indicates whether the destination is reachable from the source.
return_path_components	string	The components in the path from destination to source.
start_date	string	The time the analysis started.
status	string	The status of the network insights analysis.
status_message	string	The status message, if the status is failed.
suggested_accounts	string	Potential intermediate accounts.
tags	string	The tags.
warning_message	string	The warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_network_insights_analyses	select	region	NetworkInsightsAnalysisId, NetworkInsightsPathId, AnalysisStartTime, AnalysisEndTime, Filter, MaxResults, DryRun, NextToken	Describes one or more of your network insights analyses.

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
region	string	AWS region (default: us-east-1)
AnalysisEndTime	string (date-time)	The time when the network insights analyses ended.
AnalysisStartTime	string (date-time)	The time when the network insights analyses started.
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.
Filter	array	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).
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NetworkInsightsAnalysisId	array	The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
NetworkInsightsPathId	string	The ID of the path. You must specify either a path ID or analysis IDs.
NextToken	string	The token for the next page of results.

SELECT examples

describe_network_insights_analyses

Describes one or more of your network insights analyses.

SELECT
additional_accounts,
alternate_path_hints,
explanations,
filter_in_arns,
filter_out_arns,
forward_path_components,
network_insights_analysis_arn,
network_insights_analysis_id,
network_insights_path_id,
network_path_found,
return_path_components,
start_date,
status,
status_message,
suggested_accounts,
tags,
warning_message
FROM aws.ec2.network_insights_analyses
WHERE region = '{{ region }}' -- required
AND NetworkInsightsAnalysisId = '{{ NetworkInsightsAnalysisId }}'
AND NetworkInsightsPathId = '{{ NetworkInsightsPathId }}'
AND AnalysisStartTime = '{{ AnalysisStartTime }}'
AND AnalysisEndTime = '{{ AnalysisEndTime }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND DryRun = '{{ DryRun }}'
AND NextToken = '{{ NextToken }}'
;