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 active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
This operation returns paginated results.
Synopsis
- data DescribeClientVpnConnections = DescribeClientVpnConnections' {}
- newDescribeClientVpnConnections :: Text -> DescribeClientVpnConnections
- describeClientVpnConnections_dryRun :: Lens' DescribeClientVpnConnections (Maybe Bool)
- describeClientVpnConnections_filters :: Lens' DescribeClientVpnConnections (Maybe [Filter])
- describeClientVpnConnections_maxResults :: Lens' DescribeClientVpnConnections (Maybe Natural)
- describeClientVpnConnections_nextToken :: Lens' DescribeClientVpnConnections (Maybe Text)
- describeClientVpnConnections_clientVpnEndpointId :: Lens' DescribeClientVpnConnections Text
- data DescribeClientVpnConnectionsResponse = DescribeClientVpnConnectionsResponse' {}
- newDescribeClientVpnConnectionsResponse :: Int -> DescribeClientVpnConnectionsResponse
- describeClientVpnConnectionsResponse_connections :: Lens' DescribeClientVpnConnectionsResponse (Maybe [ClientVpnConnection])
- describeClientVpnConnectionsResponse_nextToken :: Lens' DescribeClientVpnConnectionsResponse (Maybe Text)
- describeClientVpnConnectionsResponse_httpStatus :: Lens' DescribeClientVpnConnectionsResponse Int
Creating a Request
data DescribeClientVpnConnections Source #
See: newDescribeClientVpnConnections
smart constructor.
DescribeClientVpnConnections' | |
|
Instances
newDescribeClientVpnConnections Source #
Create a value of DescribeClientVpnConnections
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:DescribeClientVpnConnections'
, describeClientVpnConnections_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:DescribeClientVpnConnections'
, describeClientVpnConnections_filters
- One or more filters. Filter names and values are case-sensitive.
connection-id
- The ID of the connection.username
- For Active Directory client authentication, the user name of the client who established the client connection.
$sel:maxResults:DescribeClientVpnConnections'
, describeClientVpnConnections_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.
DescribeClientVpnConnections
, describeClientVpnConnections_nextToken
- The token to retrieve the next page of results.
DescribeClientVpnConnections
, describeClientVpnConnections_clientVpnEndpointId
- The ID of the Client VPN endpoint.
Request Lenses
describeClientVpnConnections_dryRun :: Lens' DescribeClientVpnConnections (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
.
describeClientVpnConnections_filters :: Lens' DescribeClientVpnConnections (Maybe [Filter]) Source #
One or more filters. Filter names and values are case-sensitive.
connection-id
- The ID of the connection.username
- For Active Directory client authentication, the user name of the client who established the client connection.
describeClientVpnConnections_maxResults :: Lens' DescribeClientVpnConnections (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.
describeClientVpnConnections_nextToken :: Lens' DescribeClientVpnConnections (Maybe Text) Source #
The token to retrieve the next page of results.
describeClientVpnConnections_clientVpnEndpointId :: Lens' DescribeClientVpnConnections Text Source #
The ID of the Client VPN endpoint.
Destructuring the Response
data DescribeClientVpnConnectionsResponse Source #
See: newDescribeClientVpnConnectionsResponse
smart constructor.
DescribeClientVpnConnectionsResponse' | |
|
Instances
newDescribeClientVpnConnectionsResponse Source #
Create a value of DescribeClientVpnConnectionsResponse
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:connections:DescribeClientVpnConnectionsResponse'
, describeClientVpnConnectionsResponse_connections
- Information about the active and terminated client connections.
DescribeClientVpnConnections
, describeClientVpnConnectionsResponse_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:DescribeClientVpnConnectionsResponse'
, describeClientVpnConnectionsResponse_httpStatus
- The response's http status code.
Response Lenses
describeClientVpnConnectionsResponse_connections :: Lens' DescribeClientVpnConnectionsResponse (Maybe [ClientVpnConnection]) Source #
Information about the active and terminated client connections.
describeClientVpnConnectionsResponse_nextToken :: Lens' DescribeClientVpnConnectionsResponse (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.
describeClientVpnConnectionsResponse_httpStatus :: Lens' DescribeClientVpnConnectionsResponse Int Source #
The response's http status code.