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

Description

Describes the target networks associated with the specified Client VPN endpoint.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeClientVpnTargetNetworks Source #

See: newDescribeClientVpnTargetNetworks smart constructor.

Constructors

DescribeClientVpnTargetNetworks' 

Fields

  • associationIds :: Maybe [Text]

    The IDs of the target network associations.

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

    • association-id - The ID of the association.
    • target-network-id - The ID of the subnet specified as the target network.
    • vpc-id - The ID of the VPC in which the target network is located.
  • 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 DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

toHeaders :: DescribeClientVpnTargetNetworks -> [Header] #

ToPath DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

toPath :: DescribeClientVpnTargetNetworks -> ByteString #

ToQuery DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

toQuery :: DescribeClientVpnTargetNetworks -> QueryString #

AWSPager DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

page :: DescribeClientVpnTargetNetworks -> AWSResponse DescribeClientVpnTargetNetworks -> Maybe DescribeClientVpnTargetNetworks #

AWSRequest DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Associated Types

type AWSResponse DescribeClientVpnTargetNetworks #

Methods

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

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

Generic DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Associated Types

type Rep DescribeClientVpnTargetNetworks :: Type -> Type #

Methods

from :: DescribeClientVpnTargetNetworks -> Rep DescribeClientVpnTargetNetworks x #

to :: Rep DescribeClientVpnTargetNetworks x -> DescribeClientVpnTargetNetworks #

Read DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

readsPrec :: Int -> ReadS DescribeClientVpnTargetNetworks #

readList :: ReadS [DescribeClientVpnTargetNetworks] #

readPrec :: ReadPrec DescribeClientVpnTargetNetworks #

readListPrec :: ReadPrec [DescribeClientVpnTargetNetworks] #

Show DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

showsPrec :: Int -> DescribeClientVpnTargetNetworks -> ShowS #

show :: DescribeClientVpnTargetNetworks -> String #

showList :: [DescribeClientVpnTargetNetworks] -> ShowS #

NFData DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

rnf :: DescribeClientVpnTargetNetworks -> () #

Eq DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

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

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

Hashable DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

hashWithSalt :: Int -> DescribeClientVpnTargetNetworks -> Int #

hash :: DescribeClientVpnTargetNetworks -> Int #

type AWSResponse DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

type AWSResponse DescribeClientVpnTargetNetworks = DescribeClientVpnTargetNetworksResponse
type Rep DescribeClientVpnTargetNetworks Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

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

newDescribeClientVpnTargetNetworks Source #

Arguments

:: Text

DescribeClientVpnTargetNetworks

-> DescribeClientVpnTargetNetworks 

Create a value of DescribeClientVpnTargetNetworks 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:associationIds:DescribeClientVpnTargetNetworks', describeClientVpnTargetNetworks_associationIds - The IDs of the target network associations.

$sel:dryRun:DescribeClientVpnTargetNetworks', describeClientVpnTargetNetworks_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:DescribeClientVpnTargetNetworks', describeClientVpnTargetNetworks_filters - One or more filters. Filter names and values are case-sensitive.

  • association-id - The ID of the association.
  • target-network-id - The ID of the subnet specified as the target network.
  • vpc-id - The ID of the VPC in which the target network is located.

$sel:maxResults:DescribeClientVpnTargetNetworks', describeClientVpnTargetNetworks_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.

DescribeClientVpnTargetNetworks, describeClientVpnTargetNetworks_nextToken - The token to retrieve the next page of results.

DescribeClientVpnTargetNetworks, describeClientVpnTargetNetworks_clientVpnEndpointId - The ID of the Client VPN endpoint.

Request Lenses

describeClientVpnTargetNetworks_associationIds :: Lens' DescribeClientVpnTargetNetworks (Maybe [Text]) Source #

The IDs of the target network associations.

describeClientVpnTargetNetworks_dryRun :: Lens' DescribeClientVpnTargetNetworks (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.

describeClientVpnTargetNetworks_filters :: Lens' DescribeClientVpnTargetNetworks (Maybe [Filter]) Source #

One or more filters. Filter names and values are case-sensitive.

  • association-id - The ID of the association.
  • target-network-id - The ID of the subnet specified as the target network.
  • vpc-id - The ID of the VPC in which the target network is located.

describeClientVpnTargetNetworks_maxResults :: Lens' DescribeClientVpnTargetNetworks (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.

describeClientVpnTargetNetworks_nextToken :: Lens' DescribeClientVpnTargetNetworks (Maybe Text) Source #

The token to retrieve the next page of results.

describeClientVpnTargetNetworks_clientVpnEndpointId :: Lens' DescribeClientVpnTargetNetworks Text Source #

The ID of the Client VPN endpoint.

Destructuring the Response

data DescribeClientVpnTargetNetworksResponse Source #

See: newDescribeClientVpnTargetNetworksResponse smart constructor.

Constructors

DescribeClientVpnTargetNetworksResponse' 

Fields

Instances

Instances details
Generic DescribeClientVpnTargetNetworksResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Associated Types

type Rep DescribeClientVpnTargetNetworksResponse :: Type -> Type #

Methods

from :: DescribeClientVpnTargetNetworksResponse -> Rep DescribeClientVpnTargetNetworksResponse x #

to :: Rep DescribeClientVpnTargetNetworksResponse x -> DescribeClientVpnTargetNetworksResponse #

Read DescribeClientVpnTargetNetworksResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

readsPrec :: Int -> ReadS DescribeClientVpnTargetNetworksResponse #

readList :: ReadS [DescribeClientVpnTargetNetworksResponse] #

readPrec :: ReadPrec DescribeClientVpnTargetNetworksResponse #

readListPrec :: ReadPrec [DescribeClientVpnTargetNetworksResponse] #

Show DescribeClientVpnTargetNetworksResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

showsPrec :: Int -> DescribeClientVpnTargetNetworksResponse -> ShowS #

show :: DescribeClientVpnTargetNetworksResponse -> String #

showList :: [DescribeClientVpnTargetNetworksResponse] -> ShowS #

NFData DescribeClientVpnTargetNetworksResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

rnf :: DescribeClientVpnTargetNetworksResponse -> () #

Eq DescribeClientVpnTargetNetworksResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

Methods

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

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

type Rep DescribeClientVpnTargetNetworksResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnTargetNetworks

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

newDescribeClientVpnTargetNetworksResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeClientVpnTargetNetworksResponse'

-> DescribeClientVpnTargetNetworksResponse 

Create a value of DescribeClientVpnTargetNetworksResponse 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:clientVpnTargetNetworks:DescribeClientVpnTargetNetworksResponse', describeClientVpnTargetNetworksResponse_clientVpnTargetNetworks - Information about the associated target networks.

DescribeClientVpnTargetNetworks, describeClientVpnTargetNetworksResponse_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:DescribeClientVpnTargetNetworksResponse', describeClientVpnTargetNetworksResponse_httpStatus - The response's http status code.

Response Lenses

describeClientVpnTargetNetworksResponse_clientVpnTargetNetworks :: Lens' DescribeClientVpnTargetNetworksResponse (Maybe [TargetNetwork]) Source #

Information about the associated target networks.

describeClientVpnTargetNetworksResponse_nextToken :: Lens' DescribeClientVpnTargetNetworksResponse (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.

describeClientVpnTargetNetworksResponse_httpStatus :: Lens' DescribeClientVpnTargetNetworksResponse Int Source #

The response's http status code.