Skip to content

search_local_gateway_routes async

search_local_gateway_routes(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    local_gateway_route_table_id: Optional[LocalGatewayRoutetableId] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> SearchLocalGatewayRoutesResult

Searches for routes in the specified local gateway route table.

Parameters:

  • local_gateway_route_table_id (Optional[LocalGatewayRoutetableId], default: None ) –

    The ID of the local gateway route table.

  • filters (Optional[FilterList], default: None ) –

    One or more filters.

    • prefix-list-id - The ID of the prefix list.

    • route-search.exact-match - The exact match of the specified filter.

    • route-search.longest-prefix-match - The longest prefix that matches the route.

    • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

    • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

    • state - The state of the route.

    • type - The route type.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • next_token (Optional[String], default: None ) –

    The token for the next page of results.

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def search_local_gateway_routes(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    local_gateway_route_table_id: Optional[
        "capo_ec2.types.local_gateway_routetable_id.LocalGatewayRoutetableId"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional["capo_ec2.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.search_local_gateway_routes_result.SearchLocalGatewayRoutesResult":
    """<p>Searches for routes in the specified local gateway route table.</p>

    Args:
        local_gateway_route_table_id: <p>The ID of the local gateway route table.</p>
        filters: <p>One or more filters.</p> <ul> <li> <p> <code>prefix-list-id</code> - The ID of the prefix list.</p> </li> <li> <p> <code>route-search.exact-match</code> - The exact match of the specified filter.</p> </li> <li> <p> <code>route-search.longest-prefix-match</code> - The longest prefix that matches the route.</p> </li> <li> <p> <code>route-search.subnet-of-match</code> - The routes with a subnet that match the specified CIDR filter.</p> </li> <li> <p> <code>route-search.supernet-of-match</code> - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify <code>supernet-of-match</code> as 10.0.1.0/30, then the result returns 10.0.1.0/29.</p> </li> <li> <p> <code>state</code> - The state of the route.</p> </li> <li> <p> <code>type</code> - The route type.</p> </li> </ul>
        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>
        next_token: <p>The token for the next page of results.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.search_local_gateway_routes_request.SearchLocalGatewayRoutesRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.search_local_gateway_routes_result.SearchLocalGatewayRoutesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.search_local_gateway_routes

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.search_local_gateway_routes.async_search_local_gateway_routes(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchLocalGatewayRoutes")
    )
    input_: capo_ec2.types.search_local_gateway_routes_request.SearchLocalGatewayRoutesRequest = {}
    if local_gateway_route_table_id is not None:
        input_["local_gateway_route_table_id"] = local_gateway_route_table_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
    if dry_run is not None:
        input_["dry_run"] = dry_run

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