Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Searches for routes in the specified local gateway route table.
This operation returns paginated results.
Synopsis
- data SearchLocalGatewayRoutes = SearchLocalGatewayRoutes' {}
- newSearchLocalGatewayRoutes :: Text -> SearchLocalGatewayRoutes
- searchLocalGatewayRoutes_dryRun :: Lens' SearchLocalGatewayRoutes (Maybe Bool)
- searchLocalGatewayRoutes_filters :: Lens' SearchLocalGatewayRoutes (Maybe [Filter])
- searchLocalGatewayRoutes_maxResults :: Lens' SearchLocalGatewayRoutes (Maybe Int)
- searchLocalGatewayRoutes_nextToken :: Lens' SearchLocalGatewayRoutes (Maybe Text)
- searchLocalGatewayRoutes_localGatewayRouteTableId :: Lens' SearchLocalGatewayRoutes Text
- data SearchLocalGatewayRoutesResponse = SearchLocalGatewayRoutesResponse' {
- nextToken :: Maybe Text
- routes :: Maybe [LocalGatewayRoute]
- httpStatus :: Int
- newSearchLocalGatewayRoutesResponse :: Int -> SearchLocalGatewayRoutesResponse
- searchLocalGatewayRoutesResponse_nextToken :: Lens' SearchLocalGatewayRoutesResponse (Maybe Text)
- searchLocalGatewayRoutesResponse_routes :: Lens' SearchLocalGatewayRoutesResponse (Maybe [LocalGatewayRoute])
- searchLocalGatewayRoutesResponse_httpStatus :: Lens' SearchLocalGatewayRoutesResponse Int
Creating a Request
data SearchLocalGatewayRoutes Source #
See: newSearchLocalGatewayRoutes
smart constructor.
SearchLocalGatewayRoutes' | |
|
Instances
newSearchLocalGatewayRoutes Source #
Create a value of SearchLocalGatewayRoutes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:SearchLocalGatewayRoutes'
, searchLocalGatewayRoutes_dryRun
- 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
.
$sel:filters:SearchLocalGatewayRoutes'
, searchLocalGatewayRoutes_filters
- One or more filters.
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 specifysupernet-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.
$sel:maxResults:SearchLocalGatewayRoutes'
, searchLocalGatewayRoutes_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
SearchLocalGatewayRoutes
, searchLocalGatewayRoutes_nextToken
- The token for the next page of results.
SearchLocalGatewayRoutes
, searchLocalGatewayRoutes_localGatewayRouteTableId
- The ID of the local gateway route table.
Request Lenses
searchLocalGatewayRoutes_dryRun :: Lens' SearchLocalGatewayRoutes (Maybe Bool) Source #
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
.
searchLocalGatewayRoutes_filters :: Lens' SearchLocalGatewayRoutes (Maybe [Filter]) Source #
One or more filters.
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 specifysupernet-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.
searchLocalGatewayRoutes_maxResults :: Lens' SearchLocalGatewayRoutes (Maybe Int) Source #
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
searchLocalGatewayRoutes_nextToken :: Lens' SearchLocalGatewayRoutes (Maybe Text) Source #
The token for the next page of results.
searchLocalGatewayRoutes_localGatewayRouteTableId :: Lens' SearchLocalGatewayRoutes Text Source #
The ID of the local gateway route table.
Destructuring the Response
data SearchLocalGatewayRoutesResponse Source #
See: newSearchLocalGatewayRoutesResponse
smart constructor.
SearchLocalGatewayRoutesResponse' | |
|
Instances
newSearchLocalGatewayRoutesResponse Source #
Create a value of SearchLocalGatewayRoutesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SearchLocalGatewayRoutes
, searchLocalGatewayRoutesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
SearchLocalGatewayRoutesResponse
, searchLocalGatewayRoutesResponse_routes
- Information about the routes.
$sel:httpStatus:SearchLocalGatewayRoutesResponse'
, searchLocalGatewayRoutesResponse_httpStatus
- The response's http status code.
Response Lenses
searchLocalGatewayRoutesResponse_nextToken :: Lens' SearchLocalGatewayRoutesResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
searchLocalGatewayRoutesResponse_routes :: Lens' SearchLocalGatewayRoutesResponse (Maybe [LocalGatewayRoute]) Source #
Information about the routes.
searchLocalGatewayRoutesResponse_httpStatus :: Lens' SearchLocalGatewayRoutesResponse Int Source #
The response's http status code.