start_route_analysis ¶

def start_route_analysis(
    self,
    global_network_id: "capo_networkmanager.types.global_network_id.GlobalNetworkId",
    source: "capo_networkmanager.types.route_analysis_endpoint_options_specification.RouteAnalysisEndpointOptionsSpecification",
    destination: "capo_networkmanager.types.route_analysis_endpoint_options_specification.RouteAnalysisEndpointOptionsSpecification",
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
    include_return_path: Optional[
        "capo_networkmanager.types.boolean.Boolean"
    ] = None,
    use_middleboxes: Optional["capo_networkmanager.types.boolean.Boolean"] = None,
) -> "capo_networkmanager.types.start_route_analysis_response.StartRouteAnalysisResponse":
    """<p>Starts analyzing the routing path between the specified source and destination. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/route-analyzer.html">Route Analyzer</a>.</p>

    Args:
        global_network_id: <p>The ID of the global network.</p>
        source: <p>The source from which traffic originates.</p>
        destination: <p>The destination.</p>
        include_return_path: <p>Indicates whether to analyze the return path. The default is <code>false</code>.</p>
        use_middleboxes: <p>Indicates whether to include the location of middlebox appliances in the route analysis. The default is <code>false</code>.</p>

    Raises:
        capo_networkmanager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_networkmanager.errors.conflict_exception.ConflictException: <p>There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.</p>
        capo_networkmanager.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal error.</p>
        capo_networkmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
        capo_networkmanager.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_networkmanager.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints.</p>
        capo_networkmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_networkmanager.types.start_route_analysis_request.StartRouteAnalysisRequest]",
    ) -> OperationResponse[
        "capo_networkmanager.types.start_route_analysis_response.StartRouteAnalysisResponse"
    ]:
        import capo_networkmanager._operations.network_manager.start_route_analysis

        output, http_response = (
            capo_networkmanager._operations.network_manager.start_route_analysis.start_route_analysis(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartRouteAnalysis")
    )
    input_: capo_networkmanager.types.start_route_analysis_request.StartRouteAnalysisRequest = {
        "global_network_id": global_network_id,
        "source": source,
        "destination": destination,
    }
    if include_return_path is not None:
        input_["include_return_path"] = include_return_path
    if use_middleboxes is not None:
        input_["use_middleboxes"] = use_middleboxes

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output