Skip to content

get_route_analysis async

get_route_analysis(
    global_network_id: GlobalNetworkId,
    route_analysis_id: ConstrainedString,
    *,
    config_overrides: Optional[AsyncNetworkManagerClientConfig] = None,
) -> GetRouteAnalysisResponse

Gets information about the specified route analysis.

Parameters:

Raises:

Source code in docs_src/capo_networkmanager/_services/async_network_manager.py
async def get_route_analysis(
    self,
    global_network_id: "capo_networkmanager.types.global_network_id.GlobalNetworkId",
    route_analysis_id: "capo_networkmanager.types.constrained_string.ConstrainedString",
    *,
    config_overrides: Optional[AsyncNetworkManagerClientConfig] = None,
) -> (
    "capo_networkmanager.types.get_route_analysis_response.GetRouteAnalysisResponse"
):
    """<p>Gets information about the specified route analysis.</p>

    Args:
        global_network_id: <p>The ID of the global network.</p>
        route_analysis_id: <p>The ID of the route analysis.</p>

    Raises:
        capo_networkmanager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_networkmanager.types.get_route_analysis_request.GetRouteAnalysisRequest]",
    ) -> AsyncOperationResponse[
        "capo_networkmanager.types.get_route_analysis_response.GetRouteAnalysisResponse"
    ]:
        import capo_networkmanager._operations.network_manager.get_route_analysis

        (
            output,
            http_response,
        ) = await capo_networkmanager._operations.network_manager.get_route_analysis.async_get_route_analysis(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRouteAnalysis")
    )
    input_: capo_networkmanager.types.get_route_analysis_request.GetRouteAnalysisRequest = {
        "global_network_id": global_network_id,
        "route_analysis_id": route_analysis_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output