Skip to content

NetworkInsightsAnalysis

Source code in docs_src/capo_ec2/types/network_insights_analysis.py
class NetworkInsightsAnalysis(TypedDict, closed=True):
    network_insights_analysis_id: NotRequired[
        "capo_ec2.types.network_insights_analysis_id.NetworkInsightsAnalysisId"
    ]
    """<p>The ID of the network insights analysis.</p>"""
    network_insights_analysis_arn: NotRequired[
        "capo_ec2.types.resource_arn.ResourceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the network insights analysis.</p>"""
    network_insights_path_id: NotRequired[
        "capo_ec2.types.network_insights_path_id.NetworkInsightsPathId"
    ]
    """<p>The ID of the path.</p>"""
    additional_accounts: NotRequired["capo_ec2.types.value_string_list.ValueStringList"]
    """<p>The member accounts that contain resources that the path can traverse.</p>"""
    filter_in_arns: NotRequired["capo_ec2.types.arn_list.ArnList"]
    """<p>The Amazon Resource Names (ARN) of the resources that the path must traverse.</p>"""
    filter_out_arns: NotRequired["capo_ec2.types.arn_list.ArnList"]
    """<p>The Amazon Resource Names (ARN) of the resources that the path must ignore.</p>"""
    start_date: NotRequired["capo_ec2.types.millisecond_date_time.MillisecondDateTime"]
    """<p>The time the analysis started.</p>"""
    status: NotRequired["capo_ec2.types.analysis_status.AnalysisStatus"]
    """<p>The status of the network insights analysis.</p>"""
    status_message: NotRequired["capo_ec2.types.string.String"]
    """<p>The status message, if the status is <code>failed</code>.</p>"""
    warning_message: NotRequired["capo_ec2.types.string.String"]
    """<p>The warning message.</p>"""
    network_path_found: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the destination is reachable from the source.</p>"""
    forward_path_components: NotRequired[
        "capo_ec2.types.path_component_list.PathComponentList"
    ]
    """<p>The components in the path from source to destination.</p>"""
    return_path_components: NotRequired[
        "capo_ec2.types.path_component_list.PathComponentList"
    ]
    """<p>The components in the path from destination to source.</p>"""
    explanations: NotRequired["capo_ec2.types.explanation_list.ExplanationList"]
    """<p>The explanations. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html">Reachability Analyzer explanation codes</a>.</p>"""
    alternate_path_hints: NotRequired[
        "capo_ec2.types.alternate_path_hint_list.AlternatePathHintList"
    ]
    """<p>Potential intermediate components.</p>"""
    suggested_accounts: NotRequired["capo_ec2.types.value_string_list.ValueStringList"]
    """<p>Potential intermediate accounts.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>The tags.</p>"""

additional_accounts instance-attribute

additional_accounts: NotRequired[ValueStringList]

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

alternate_path_hints instance-attribute

alternate_path_hints: NotRequired[AlternatePathHintList]

Potential intermediate components.

explanations instance-attribute

explanations: NotRequired[ExplanationList]

The explanations. For more information, see Reachability Analyzer explanation codes.

filter_in_arns instance-attribute

filter_in_arns: NotRequired[ArnList]

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

filter_out_arns instance-attribute

filter_out_arns: NotRequired[ArnList]

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

forward_path_components instance-attribute

forward_path_components: NotRequired[PathComponentList]

The components in the path from source to destination.

network_insights_analysis_arn instance-attribute

network_insights_analysis_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the network insights analysis.

network_insights_analysis_id instance-attribute

network_insights_analysis_id: NotRequired[NetworkInsightsAnalysisId]

The ID of the network insights analysis.

network_insights_path_id instance-attribute

network_insights_path_id: NotRequired[NetworkInsightsPathId]

The ID of the path.

network_path_found instance-attribute

network_path_found: NotRequired[Boolean]

Indicates whether the destination is reachable from the source.

return_path_components instance-attribute

return_path_components: NotRequired[PathComponentList]

The components in the path from destination to source.

start_date instance-attribute

start_date: NotRequired[MillisecondDateTime]

The time the analysis started.

status instance-attribute

status: NotRequired[AnalysisStatus]

The status of the network insights analysis.

status_message instance-attribute

status_message: NotRequired[String]

The status message, if the status is failed.

suggested_accounts instance-attribute

suggested_accounts: NotRequired[ValueStringList]

Potential intermediate accounts.

tags instance-attribute

tags: NotRequired[TagList]

The tags.

warning_message instance-attribute

warning_message: NotRequired[String]

The warning message.