| 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 |
Amazonka.EC2.DescribeClientVpnRoutes
Description
Describes the routes for the specified Client VPN endpoint.
This operation returns paginated results.
Synopsis
- data DescribeClientVpnRoutes = DescribeClientVpnRoutes' {}
- newDescribeClientVpnRoutes :: Text -> DescribeClientVpnRoutes
- describeClientVpnRoutes_dryRun :: Lens' DescribeClientVpnRoutes (Maybe Bool)
- describeClientVpnRoutes_filters :: Lens' DescribeClientVpnRoutes (Maybe [Filter])
- describeClientVpnRoutes_maxResults :: Lens' DescribeClientVpnRoutes (Maybe Natural)
- describeClientVpnRoutes_nextToken :: Lens' DescribeClientVpnRoutes (Maybe Text)
- describeClientVpnRoutes_clientVpnEndpointId :: Lens' DescribeClientVpnRoutes Text
- data DescribeClientVpnRoutesResponse = DescribeClientVpnRoutesResponse' {
- nextToken :: Maybe Text
- routes :: Maybe [ClientVpnRoute]
- httpStatus :: Int
- newDescribeClientVpnRoutesResponse :: Int -> DescribeClientVpnRoutesResponse
- describeClientVpnRoutesResponse_nextToken :: Lens' DescribeClientVpnRoutesResponse (Maybe Text)
- describeClientVpnRoutesResponse_routes :: Lens' DescribeClientVpnRoutesResponse (Maybe [ClientVpnRoute])
- describeClientVpnRoutesResponse_httpStatus :: Lens' DescribeClientVpnRoutesResponse Int
Creating a Request
data DescribeClientVpnRoutes Source #
See: newDescribeClientVpnRoutes smart constructor.
Constructors
| DescribeClientVpnRoutes' | |
Fields
| |
Instances
newDescribeClientVpnRoutes Source #
Arguments
| :: Text | |
| -> DescribeClientVpnRoutes |
Create a value of DescribeClientVpnRoutes 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:DescribeClientVpnRoutes', describeClientVpnRoutes_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:DescribeClientVpnRoutes', describeClientVpnRoutes_filters - One or more filters. Filter names and values are case-sensitive.
destination-cidr- The CIDR of the route destination.origin- How the route was associated with the Client VPN endpoint (associate|add-route).target-subnet- The ID of the subnet through which traffic is routed.
$sel:maxResults:DescribeClientVpnRoutes', describeClientVpnRoutes_maxResults - The maximum number of results to return for the request in a single
page. The remaining results can be seen by sending another request with
the nextToken value.
DescribeClientVpnRoutes, describeClientVpnRoutes_nextToken - The token to retrieve the next page of results.
DescribeClientVpnRoutes, describeClientVpnRoutes_clientVpnEndpointId - The ID of the Client VPN endpoint.
Request Lenses
describeClientVpnRoutes_dryRun :: Lens' DescribeClientVpnRoutes (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.
describeClientVpnRoutes_filters :: Lens' DescribeClientVpnRoutes (Maybe [Filter]) Source #
One or more filters. Filter names and values are case-sensitive.
destination-cidr- The CIDR of the route destination.origin- How the route was associated with the Client VPN endpoint (associate|add-route).target-subnet- The ID of the subnet through which traffic is routed.
describeClientVpnRoutes_maxResults :: Lens' DescribeClientVpnRoutes (Maybe Natural) Source #
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
describeClientVpnRoutes_nextToken :: Lens' DescribeClientVpnRoutes (Maybe Text) Source #
The token to retrieve the next page of results.
describeClientVpnRoutes_clientVpnEndpointId :: Lens' DescribeClientVpnRoutes Text Source #
The ID of the Client VPN endpoint.
Destructuring the Response
data DescribeClientVpnRoutesResponse Source #
See: newDescribeClientVpnRoutesResponse smart constructor.
Constructors
| DescribeClientVpnRoutesResponse' | |
Fields
| |
Instances
newDescribeClientVpnRoutesResponse Source #
Create a value of DescribeClientVpnRoutesResponse 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:
DescribeClientVpnRoutes, describeClientVpnRoutesResponse_nextToken - The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
DescribeClientVpnRoutesResponse, describeClientVpnRoutesResponse_routes - Information about the Client VPN endpoint routes.
$sel:httpStatus:DescribeClientVpnRoutesResponse', describeClientVpnRoutesResponse_httpStatus - The response's http status code.
Response Lenses
describeClientVpnRoutesResponse_nextToken :: Lens' DescribeClientVpnRoutesResponse (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.
describeClientVpnRoutesResponse_routes :: Lens' DescribeClientVpnRoutesResponse (Maybe [ClientVpnRoute]) Source #
Information about the Client VPN endpoint routes.
describeClientVpnRoutesResponse_httpStatus :: Lens' DescribeClientVpnRoutesResponse Int Source #
The response's http status code.