Skip to content

RouteAnalysis

Source code in docs_src/capo_networkmanager/types/route_analysis.py
class RouteAnalysis(TypedDict, closed=True):
    global_network_id: NotRequired[
        "capo_networkmanager.types.global_network_id.GlobalNetworkId"
    ]
    """<p>The ID of the global network.</p>"""
    owner_account_id: NotRequired[
        "capo_networkmanager.types.aws_account_id.AWSAccountId"
    ]
    """<p>The ID of the AWS account that created the route analysis.</p>"""
    route_analysis_id: NotRequired[
        "capo_networkmanager.types.constrained_string.ConstrainedString"
    ]
    """<p>The ID of the route analysis.</p>"""
    start_timestamp: NotRequired["capo_networkmanager.types.date_time.DateTime"]
    """<p>The time that the analysis started.</p>"""
    status: NotRequired[
        "capo_networkmanager.types.route_analysis_status.RouteAnalysisStatus"
    ]
    """<p>The status of the route analysis.</p>"""
    source: NotRequired[
        "capo_networkmanager.types.route_analysis_endpoint_options.RouteAnalysisEndpointOptions"
    ]
    """<p>The source.</p>"""
    destination: NotRequired[
        "capo_networkmanager.types.route_analysis_endpoint_options.RouteAnalysisEndpointOptions"
    ]
    """<p>The destination.</p>"""
    include_return_path: "capo_networkmanager.types.boolean.Boolean"
    """<p>Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.</p>"""
    use_middleboxes: "capo_networkmanager.types.boolean.Boolean"
    """<p>Indicates whether to include the location of middlebox appliances in the route analysis.</p>"""
    forward_path: NotRequired[
        "capo_networkmanager.types.route_analysis_path.RouteAnalysisPath"
    ]
    """<p>The forward path.</p>"""
    return_path: NotRequired[
        "capo_networkmanager.types.route_analysis_path.RouteAnalysisPath"
    ]
    """<p>The return path.</p>"""

destination instance-attribute

destination: NotRequired[RouteAnalysisEndpointOptions]

The destination.

forward_path instance-attribute

forward_path: NotRequired[RouteAnalysisPath]

The forward path.

global_network_id instance-attribute

global_network_id: NotRequired[GlobalNetworkId]

The ID of the global network.

include_return_path instance-attribute

include_return_path: Boolean

Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

owner_account_id instance-attribute

owner_account_id: NotRequired[AWSAccountId]

The ID of the AWS account that created the route analysis.

return_path instance-attribute

return_path: NotRequired[RouteAnalysisPath]

The return path.

route_analysis_id instance-attribute

route_analysis_id: NotRequired[ConstrainedString]

The ID of the route analysis.

source instance-attribute

source: NotRequired[RouteAnalysisEndpointOptions]

The source.

start_timestamp instance-attribute

start_timestamp: NotRequired[DateTime]

The time that the analysis started.

status instance-attribute

status: NotRequired[RouteAnalysisStatus]

The status of the route analysis.

use_middleboxes instance-attribute

use_middleboxes: Boolean

Indicates whether to include the location of middlebox appliances in the route analysis.