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 |
Describes one or more Client VPN endpoints in the account.
This operation returns paginated results.
Synopsis
- data DescribeClientVpnEndpoints = DescribeClientVpnEndpoints' {}
- newDescribeClientVpnEndpoints :: DescribeClientVpnEndpoints
- describeClientVpnEndpoints_clientVpnEndpointIds :: Lens' DescribeClientVpnEndpoints (Maybe [Text])
- describeClientVpnEndpoints_dryRun :: Lens' DescribeClientVpnEndpoints (Maybe Bool)
- describeClientVpnEndpoints_filters :: Lens' DescribeClientVpnEndpoints (Maybe [Filter])
- describeClientVpnEndpoints_maxResults :: Lens' DescribeClientVpnEndpoints (Maybe Natural)
- describeClientVpnEndpoints_nextToken :: Lens' DescribeClientVpnEndpoints (Maybe Text)
- data DescribeClientVpnEndpointsResponse = DescribeClientVpnEndpointsResponse' {}
- newDescribeClientVpnEndpointsResponse :: Int -> DescribeClientVpnEndpointsResponse
- describeClientVpnEndpointsResponse_clientVpnEndpoints :: Lens' DescribeClientVpnEndpointsResponse (Maybe [ClientVpnEndpoint])
- describeClientVpnEndpointsResponse_nextToken :: Lens' DescribeClientVpnEndpointsResponse (Maybe Text)
- describeClientVpnEndpointsResponse_httpStatus :: Lens' DescribeClientVpnEndpointsResponse Int
Creating a Request
data DescribeClientVpnEndpoints Source #
See: newDescribeClientVpnEndpoints
smart constructor.
DescribeClientVpnEndpoints' | |
|
Instances
newDescribeClientVpnEndpoints :: DescribeClientVpnEndpoints Source #
Create a value of DescribeClientVpnEndpoints
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:clientVpnEndpointIds:DescribeClientVpnEndpoints'
, describeClientVpnEndpoints_clientVpnEndpointIds
- The ID of the Client VPN endpoint.
$sel:dryRun:DescribeClientVpnEndpoints'
, describeClientVpnEndpoints_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:DescribeClientVpnEndpoints'
, describeClientVpnEndpoints_filters
- One or more filters. Filter names and values are case-sensitive.
endpoint-id
- The ID of the Client VPN endpoint.transport-protocol
- The transport protocol (tcp
|udp
).
$sel:maxResults:DescribeClientVpnEndpoints'
, describeClientVpnEndpoints_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.
DescribeClientVpnEndpoints
, describeClientVpnEndpoints_nextToken
- The token to retrieve the next page of results.
Request Lenses
describeClientVpnEndpoints_clientVpnEndpointIds :: Lens' DescribeClientVpnEndpoints (Maybe [Text]) Source #
The ID of the Client VPN endpoint.
describeClientVpnEndpoints_dryRun :: Lens' DescribeClientVpnEndpoints (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
.
describeClientVpnEndpoints_filters :: Lens' DescribeClientVpnEndpoints (Maybe [Filter]) Source #
One or more filters. Filter names and values are case-sensitive.
endpoint-id
- The ID of the Client VPN endpoint.transport-protocol
- The transport protocol (tcp
|udp
).
describeClientVpnEndpoints_maxResults :: Lens' DescribeClientVpnEndpoints (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.
describeClientVpnEndpoints_nextToken :: Lens' DescribeClientVpnEndpoints (Maybe Text) Source #
The token to retrieve the next page of results.
Destructuring the Response
data DescribeClientVpnEndpointsResponse Source #
See: newDescribeClientVpnEndpointsResponse
smart constructor.
DescribeClientVpnEndpointsResponse' | |
|
Instances
newDescribeClientVpnEndpointsResponse Source #
Create a value of DescribeClientVpnEndpointsResponse
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:clientVpnEndpoints:DescribeClientVpnEndpointsResponse'
, describeClientVpnEndpointsResponse_clientVpnEndpoints
- Information about the Client VPN endpoints.
DescribeClientVpnEndpoints
, describeClientVpnEndpointsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:DescribeClientVpnEndpointsResponse'
, describeClientVpnEndpointsResponse_httpStatus
- The response's http status code.
Response Lenses
describeClientVpnEndpointsResponse_clientVpnEndpoints :: Lens' DescribeClientVpnEndpointsResponse (Maybe [ClientVpnEndpoint]) Source #
Information about the Client VPN endpoints.
describeClientVpnEndpointsResponse_nextToken :: Lens' DescribeClientVpnEndpointsResponse (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.
describeClientVpnEndpointsResponse_httpStatus :: Lens' DescribeClientVpnEndpointsResponse Int Source #
The response's http status code.