amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeClientVpnEndpoints

Description

Describes one or more Client VPN endpoints in the account.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeClientVpnEndpoints Source #

See: newDescribeClientVpnEndpoints smart constructor.

Constructors

DescribeClientVpnEndpoints' 

Fields

  • clientVpnEndpointIds :: Maybe [Text]

    The ID of the Client VPN endpoint.

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

    • endpoint-id - The ID of the Client VPN endpoint.
    • transport-protocol - The transport protocol (tcp | udp).
  • 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.

Instances

Instances details
ToHeaders DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

toHeaders :: DescribeClientVpnEndpoints -> [Header] #

ToPath DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

toPath :: DescribeClientVpnEndpoints -> ByteString #

ToQuery DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

toQuery :: DescribeClientVpnEndpoints -> QueryString #

AWSPager DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

page :: DescribeClientVpnEndpoints -> AWSResponse DescribeClientVpnEndpoints -> Maybe DescribeClientVpnEndpoints #

AWSRequest DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Associated Types

type AWSResponse DescribeClientVpnEndpoints #

Methods

request :: (Service -> Service) -> DescribeClientVpnEndpoints -> Request DescribeClientVpnEndpoints #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeClientVpnEndpoints -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeClientVpnEndpoints))) #

Generic DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Associated Types

type Rep DescribeClientVpnEndpoints :: Type -> Type #

Methods

from :: DescribeClientVpnEndpoints -> Rep DescribeClientVpnEndpoints x #

to :: Rep DescribeClientVpnEndpoints x -> DescribeClientVpnEndpoints #

Read DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

readsPrec :: Int -> ReadS DescribeClientVpnEndpoints #

readList :: ReadS [DescribeClientVpnEndpoints] #

readPrec :: ReadPrec DescribeClientVpnEndpoints #

readListPrec :: ReadPrec [DescribeClientVpnEndpoints] #

Show DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

showsPrec :: Int -> DescribeClientVpnEndpoints -> ShowS #

show :: DescribeClientVpnEndpoints -> String #

showList :: [DescribeClientVpnEndpoints] -> ShowS #

NFData DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

rnf :: DescribeClientVpnEndpoints -> () #

Eq DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

(==) :: DescribeClientVpnEndpoints -> DescribeClientVpnEndpoints -> Bool #

(/=) :: DescribeClientVpnEndpoints -> DescribeClientVpnEndpoints -> Bool #

Hashable DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

hashWithSalt :: Int -> DescribeClientVpnEndpoints -> Int #

hash :: DescribeClientVpnEndpoints -> Int #

type AWSResponse DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

type AWSResponse DescribeClientVpnEndpoints = DescribeClientVpnEndpointsResponse
type Rep DescribeClientVpnEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

type Rep DescribeClientVpnEndpoints = D1 ('MetaData "DescribeClientVpnEndpoints" "Amazonka.EC2.DescribeClientVpnEndpoints" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeClientVpnEndpoints'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientVpnEndpointIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: 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))))))

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.

Constructors

DescribeClientVpnEndpointsResponse' 

Fields

Instances

Instances details
Generic DescribeClientVpnEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Associated Types

type Rep DescribeClientVpnEndpointsResponse :: Type -> Type #

Methods

from :: DescribeClientVpnEndpointsResponse -> Rep DescribeClientVpnEndpointsResponse x #

to :: Rep DescribeClientVpnEndpointsResponse x -> DescribeClientVpnEndpointsResponse #

Read DescribeClientVpnEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

readsPrec :: Int -> ReadS DescribeClientVpnEndpointsResponse #

readList :: ReadS [DescribeClientVpnEndpointsResponse] #

readPrec :: ReadPrec DescribeClientVpnEndpointsResponse #

readListPrec :: ReadPrec [DescribeClientVpnEndpointsResponse] #

Show DescribeClientVpnEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

showsPrec :: Int -> DescribeClientVpnEndpointsResponse -> ShowS #

show :: DescribeClientVpnEndpointsResponse -> String #

showList :: [DescribeClientVpnEndpointsResponse] -> ShowS #

NFData DescribeClientVpnEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

rnf :: DescribeClientVpnEndpointsResponse -> () #

Eq DescribeClientVpnEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

Methods

(==) :: DescribeClientVpnEndpointsResponse -> DescribeClientVpnEndpointsResponse -> Bool #

(/=) :: DescribeClientVpnEndpointsResponse -> DescribeClientVpnEndpointsResponse -> Bool #

type Rep DescribeClientVpnEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnEndpoints

type Rep DescribeClientVpnEndpointsResponse = D1 ('MetaData "DescribeClientVpnEndpointsResponse" "Amazonka.EC2.DescribeClientVpnEndpoints" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeClientVpnEndpointsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientVpnEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClientVpnEndpoint])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeClientVpnEndpointsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeClientVpnEndpointsResponse'

-> DescribeClientVpnEndpointsResponse 

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.