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.DescribeClientVpnConnections

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DescribeClientVpnConnections Source #

See: newDescribeClientVpnConnections smart constructor.

Constructors

DescribeClientVpnConnections'

Fields

dryRun :: Maybe Bool
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.
filters :: Maybe [Filter]
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.
maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
The token to retrieve the next page of results.
clientVpnEndpointId :: Text
The ID of the Client VPN endpoint.

Instances

Instances details

ToHeaders DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods toHeaders :: DescribeClientVpnConnections -> [Header] #
ToPath DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods toPath :: DescribeClientVpnConnections -> ByteString #
ToQuery DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods toQuery :: DescribeClientVpnConnections -> QueryString #
AWSPager DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods page :: DescribeClientVpnConnections -> AWSResponse DescribeClientVpnConnections -> Maybe DescribeClientVpnConnections #
AWSRequest DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Associated Types type AWSResponse DescribeClientVpnConnections # Methods request :: (Service -> Service) -> DescribeClientVpnConnections -> Request DescribeClientVpnConnections # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeClientVpnConnections -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeClientVpnConnections))) #
Generic DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Associated Types type Rep DescribeClientVpnConnections :: Type -> Type # Methods from :: DescribeClientVpnConnections -> Rep DescribeClientVpnConnections x # to :: Rep DescribeClientVpnConnections x -> DescribeClientVpnConnections #
Read DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods readsPrec :: Int -> ReadS DescribeClientVpnConnections # readList :: ReadS [DescribeClientVpnConnections] # readPrec :: ReadPrec DescribeClientVpnConnections # readListPrec :: ReadPrec [DescribeClientVpnConnections] #
Show DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods showsPrec :: Int -> DescribeClientVpnConnections -> ShowS # show :: DescribeClientVpnConnections -> String # showList :: [DescribeClientVpnConnections] -> ShowS #
NFData DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods rnf :: DescribeClientVpnConnections -> () #
Eq DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods (==) :: DescribeClientVpnConnections -> DescribeClientVpnConnections -> Bool # (/=) :: DescribeClientVpnConnections -> DescribeClientVpnConnections -> Bool #
Hashable DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods hashWithSalt :: Int -> DescribeClientVpnConnections -> Int # hash :: DescribeClientVpnConnections -> Int #
type AWSResponse DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections type AWSResponse DescribeClientVpnConnections = DescribeClientVpnConnectionsResponse
type Rep DescribeClientVpnConnections Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections type Rep DescribeClientVpnConnections = D1 ('MetaData "DescribeClientVpnConnections" "Amazonka.EC2.DescribeClientVpnConnections" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeClientVpnConnections'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientVpnEndpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeClientVpnConnections Source #

Arguments

:: Text	`DescribeClientVpnConnections`
-> DescribeClientVpnConnections

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.

Constructors

DescribeClientVpnConnectionsResponse'
Fields connections :: Maybe [ClientVpnConnection] Information about the active and terminated client connections. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeClientVpnConnectionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Associated Types type Rep DescribeClientVpnConnectionsResponse :: Type -> Type # Methods from :: DescribeClientVpnConnectionsResponse -> Rep DescribeClientVpnConnectionsResponse x # to :: Rep DescribeClientVpnConnectionsResponse x -> DescribeClientVpnConnectionsResponse #
Read DescribeClientVpnConnectionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods readsPrec :: Int -> ReadS DescribeClientVpnConnectionsResponse # readList :: ReadS [DescribeClientVpnConnectionsResponse] # readPrec :: ReadPrec DescribeClientVpnConnectionsResponse # readListPrec :: ReadPrec [DescribeClientVpnConnectionsResponse] #
Show DescribeClientVpnConnectionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods showsPrec :: Int -> DescribeClientVpnConnectionsResponse -> ShowS # show :: DescribeClientVpnConnectionsResponse -> String # showList :: [DescribeClientVpnConnectionsResponse] -> ShowS #
NFData DescribeClientVpnConnectionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods rnf :: DescribeClientVpnConnectionsResponse -> () #
Eq DescribeClientVpnConnectionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections Methods (==) :: DescribeClientVpnConnectionsResponse -> DescribeClientVpnConnectionsResponse -> Bool # (/=) :: DescribeClientVpnConnectionsResponse -> DescribeClientVpnConnectionsResponse -> Bool #
type Rep DescribeClientVpnConnectionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeClientVpnConnections type Rep DescribeClientVpnConnectionsResponse = D1 ('MetaData "DescribeClientVpnConnectionsResponse" "Amazonka.EC2.DescribeClientVpnConnections" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeClientVpnConnectionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClientVpnConnection])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeClientVpnConnectionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeClientVpnConnectionsResponse'`
-> DescribeClientVpnConnectionsResponse

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.