search_transit_gateway_routes ¶

def search_transit_gateway_routes(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_route_table_id: Optional[
        "capo_ec2.types.transit_gateway_route_table_id.TransitGatewayRouteTableId"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.transit_gateway_max_results.TransitGatewayMaxResults"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.search_transit_gateway_routes_result.SearchTransitGatewayRoutesResult":
    """<p>Searches for routes in the specified transit gateway route table.</p>

    Args:
        transit_gateway_route_table_id: <p>The ID of the transit gateway route table.</p>
        filters: <p>One or more filters. The possible values are:</p> <ul> <li> <p> <code>attachment.transit-gateway-attachment-id</code>- The id of the transit gateway attachment.</p> </li> <li> <p> <code>attachment.resource-id</code> - The resource id of the transit gateway attachment.</p> </li> <li> <p> <code>attachment.resource-type</code> - The attachment resource type. Valid values are <code>vpc</code> | <code>vpn</code> | <code>direct-connect-gateway</code> | <code>peering</code> | <code>connect</code>.</p> </li> <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 supernet-of-match 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 (<code>active</code> | <code>blackhole</code>).</p> </li> <li> <p> <code>type</code> - The type of route (<code>propagated</code> | <code>static</code>).</p> </li> </ul>
        max_results: <p>The maximum number of routes to return. If a value is not provided, the default is 1000.</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>
        next_token: <p>The token for the next page of results.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.search_transit_gateway_routes_request.SearchTransitGatewayRoutesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.search_transit_gateway_routes_result.SearchTransitGatewayRoutesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.search_transit_gateway_routes

        output, http_response = (
            capo_ec2._operations.amazon_ec2.search_transit_gateway_routes.search_transit_gateway_routes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchTransitGatewayRoutes")
    )
    input_: capo_ec2.types.search_transit_gateway_routes_request.SearchTransitGatewayRoutesRequest = {}
    if transit_gateway_route_table_id is not None:
        input_["transit_gateway_route_table_id"] = transit_gateway_route_table_id
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if next_token is not None:
        input_["next_token"] = next_token

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