Skip to content

describe_router_configuration async

describe_router_configuration(
    virtual_interface_id: VirtualInterfaceId,
    *,
    config_overrides: Optional[AsyncDirectConnectClientConfig] = None,
    router_type_identifier: Optional[RouterTypeIdentifier] = None,
) -> DescribeRouterConfigurationResponse

Details about the router.

Parameters:

  • virtual_interface_id (VirtualInterfaceId) –

    The ID of the virtual interface.

  • router_type_identifier (Optional[RouterTypeIdentifier], default: None ) –

    Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

Raises:

Source code in docs_src/capo_direct_connect/_services/async_direct_connect.py
async def describe_router_configuration(
    self,
    virtual_interface_id: "capo_direct_connect.types.virtual_interface_id.VirtualInterfaceId",
    *,
    config_overrides: Optional[AsyncDirectConnectClientConfig] = None,
    router_type_identifier: Optional[
        "capo_direct_connect.types.router_type_identifier.RouterTypeIdentifier"
    ] = None,
) -> "capo_direct_connect.types.describe_router_configuration_response.DescribeRouterConfigurationResponse":
    """<p> Details about the router. </p>

    Args:
        virtual_interface_id: <p>The ID of the virtual interface.</p>
        router_type_identifier: <p>Identifies the router by a combination of vendor, platform, and software version. For example, <code>CiscoSystemsInc-2900SeriesRouters-IOS124</code>.</p>

    Raises:
        capo_direct_connect.errors.direct_connect_client_exception.DirectConnectClientException: <p>One or more parameters are not valid.</p>
        capo_direct_connect.errors.direct_connect_server_exception.DirectConnectServerException: <p>A server-side error occurred.</p>
        capo_direct_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_direct_connect.types.describe_router_configuration_request.DescribeRouterConfigurationRequest]",
    ) -> AsyncOperationResponse[
        "capo_direct_connect.types.describe_router_configuration_response.DescribeRouterConfigurationResponse"
    ]:
        import capo_direct_connect._operations.overture_service.describe_router_configuration

        (
            output,
            http_response,
        ) = await capo_direct_connect._operations.overture_service.describe_router_configuration.async_describe_router_configuration(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRouterConfiguration")
    )
    input_: capo_direct_connect.types.describe_router_configuration_request.DescribeRouterConfigurationRequest = {
        "virtual_interface_id": virtual_interface_id
    }
    if router_type_identifier is not None:
        input_["router_type_identifier"] = router_type_identifier

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