list_virtual_interface_routes async ¶

async def list_virtual_interface_routes(
    self,
    *,
    config_overrides: Optional[AsyncDirectConnectClientConfig] = None,
    virtual_interface_id: Optional[
        "capo_direct_connect.types.virtual_interface_id.VirtualInterfaceId"
    ] = None,
    filters: Optional[
        "capo_direct_connect.types.route_filters.RouteFilters"
    ] = None,
    max_results: Optional[
        "capo_direct_connect.types.max_result_set_size.MaxResultSetSize"
    ] = None,
    next_token: Optional[
        "capo_direct_connect.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_direct_connect.types.list_virtual_interface_routes_response.ListVirtualInterfaceRoutesResponse":
    """<p>Lists the routes for the specified virtual interface.</p> <p>Use the <code>routeDirection</code> filter to control which routes are returned:</p> <ul> <li> <p> <code>accepted</code>: routes received from the customer network over the virtual interface.</p> </li> <li> <p> <code>advertised</code>: routes advertised to the customer network over the virtual interface.</p> </li> </ul>

    Args:
        virtual_interface_id: <p>The ID of the virtual interface.</p>
        filters: <p>The filters to apply to the routes returned.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p> <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are returned.</p>
        next_token: <p>The token for the next page of results.</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.list_virtual_interface_routes_request.ListVirtualInterfaceRoutesRequest]",
    ) -> AsyncOperationResponse[
        "capo_direct_connect.types.list_virtual_interface_routes_response.ListVirtualInterfaceRoutesResponse"
    ]:
        import capo_direct_connect._operations.overture_service.list_virtual_interface_routes

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListVirtualInterfaceRoutes")
    )
    input_: capo_direct_connect.types.list_virtual_interface_routes_request.ListVirtualInterfaceRoutesRequest = {}
    if virtual_interface_id is not None:
        input_["virtual_interface_id"] = virtual_interface_id
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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