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

Description

Describes the authorization rules for a specified Client VPN endpoint.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeClientVpnAuthorizationRules Source #

See: newDescribeClientVpnAuthorizationRules smart constructor.

Constructors

DescribeClientVpnAuthorizationRules' 

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.

    • description - The description of the authorization rule.
    • destination-cidr - The CIDR of the network to which the authorization rule applies.
    • group-id - The ID of the Active Directory group to which the authorization rule grants access.
  • 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 DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

toHeaders :: DescribeClientVpnAuthorizationRules -> [Header] #

ToPath DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

toPath :: DescribeClientVpnAuthorizationRules -> ByteString #

ToQuery DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

toQuery :: DescribeClientVpnAuthorizationRules -> QueryString #

AWSPager DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

page :: DescribeClientVpnAuthorizationRules -> AWSResponse DescribeClientVpnAuthorizationRules -> Maybe DescribeClientVpnAuthorizationRules #

AWSRequest DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Associated Types

type AWSResponse DescribeClientVpnAuthorizationRules #

Methods

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

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

Generic DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Associated Types

type Rep DescribeClientVpnAuthorizationRules :: Type -> Type #

Methods

from :: DescribeClientVpnAuthorizationRules -> Rep DescribeClientVpnAuthorizationRules x #

to :: Rep DescribeClientVpnAuthorizationRules x -> DescribeClientVpnAuthorizationRules #

Read DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

readsPrec :: Int -> ReadS DescribeClientVpnAuthorizationRules #

readList :: ReadS [DescribeClientVpnAuthorizationRules] #

readPrec :: ReadPrec DescribeClientVpnAuthorizationRules #

readListPrec :: ReadPrec [DescribeClientVpnAuthorizationRules] #

Show DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

showsPrec :: Int -> DescribeClientVpnAuthorizationRules -> ShowS #

show :: DescribeClientVpnAuthorizationRules -> String #

showList :: [DescribeClientVpnAuthorizationRules] -> ShowS #

NFData DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

rnf :: DescribeClientVpnAuthorizationRules -> () #

Eq DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

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

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

Hashable DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

hashWithSalt :: Int -> DescribeClientVpnAuthorizationRules -> Int #

hash :: DescribeClientVpnAuthorizationRules -> Int #

type AWSResponse DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

type AWSResponse DescribeClientVpnAuthorizationRules = DescribeClientVpnAuthorizationRulesResponse
type Rep DescribeClientVpnAuthorizationRules Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

type Rep DescribeClientVpnAuthorizationRules = D1 ('MetaData "DescribeClientVpnAuthorizationRules" "Amazonka.EC2.DescribeClientVpnAuthorizationRules" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeClientVpnAuthorizationRules'" '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)))))

newDescribeClientVpnAuthorizationRules Source #

Arguments

:: Text

DescribeClientVpnAuthorizationRules

-> DescribeClientVpnAuthorizationRules 

Create a value of DescribeClientVpnAuthorizationRules 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:DescribeClientVpnAuthorizationRules', describeClientVpnAuthorizationRules_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:DescribeClientVpnAuthorizationRules', describeClientVpnAuthorizationRules_filters - One or more filters. Filter names and values are case-sensitive.

  • description - The description of the authorization rule.
  • destination-cidr - The CIDR of the network to which the authorization rule applies.
  • group-id - The ID of the Active Directory group to which the authorization rule grants access.

$sel:maxResults:DescribeClientVpnAuthorizationRules', describeClientVpnAuthorizationRules_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.

DescribeClientVpnAuthorizationRules, describeClientVpnAuthorizationRules_nextToken - The token to retrieve the next page of results.

DescribeClientVpnAuthorizationRules, describeClientVpnAuthorizationRules_clientVpnEndpointId - The ID of the Client VPN endpoint.

Request Lenses

describeClientVpnAuthorizationRules_dryRun :: Lens' DescribeClientVpnAuthorizationRules (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.

describeClientVpnAuthorizationRules_filters :: Lens' DescribeClientVpnAuthorizationRules (Maybe [Filter]) Source #

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

  • description - The description of the authorization rule.
  • destination-cidr - The CIDR of the network to which the authorization rule applies.
  • group-id - The ID of the Active Directory group to which the authorization rule grants access.

describeClientVpnAuthorizationRules_maxResults :: Lens' DescribeClientVpnAuthorizationRules (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.

describeClientVpnAuthorizationRules_nextToken :: Lens' DescribeClientVpnAuthorizationRules (Maybe Text) Source #

The token to retrieve the next page of results.

describeClientVpnAuthorizationRules_clientVpnEndpointId :: Lens' DescribeClientVpnAuthorizationRules Text Source #

The ID of the Client VPN endpoint.

Destructuring the Response

data DescribeClientVpnAuthorizationRulesResponse Source #

See: newDescribeClientVpnAuthorizationRulesResponse smart constructor.

Constructors

DescribeClientVpnAuthorizationRulesResponse' 

Fields

Instances

Instances details
Generic DescribeClientVpnAuthorizationRulesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Associated Types

type Rep DescribeClientVpnAuthorizationRulesResponse :: Type -> Type #

Methods

from :: DescribeClientVpnAuthorizationRulesResponse -> Rep DescribeClientVpnAuthorizationRulesResponse x #

to :: Rep DescribeClientVpnAuthorizationRulesResponse x -> DescribeClientVpnAuthorizationRulesResponse #

Read DescribeClientVpnAuthorizationRulesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

readsPrec :: Int -> ReadS DescribeClientVpnAuthorizationRulesResponse #

readList :: ReadS [DescribeClientVpnAuthorizationRulesResponse] #

readPrec :: ReadPrec DescribeClientVpnAuthorizationRulesResponse #

readListPrec :: ReadPrec [DescribeClientVpnAuthorizationRulesResponse] #

Show DescribeClientVpnAuthorizationRulesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

showsPrec :: Int -> DescribeClientVpnAuthorizationRulesResponse -> ShowS #

show :: DescribeClientVpnAuthorizationRulesResponse -> String #

showList :: [DescribeClientVpnAuthorizationRulesResponse] -> ShowS #

NFData DescribeClientVpnAuthorizationRulesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

rnf :: DescribeClientVpnAuthorizationRulesResponse -> () #

Eq DescribeClientVpnAuthorizationRulesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

Methods

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

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

type Rep DescribeClientVpnAuthorizationRulesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClientVpnAuthorizationRules

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

newDescribeClientVpnAuthorizationRulesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeClientVpnAuthorizationRulesResponse'

-> DescribeClientVpnAuthorizationRulesResponse 

Create a value of DescribeClientVpnAuthorizationRulesResponse 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:authorizationRules:DescribeClientVpnAuthorizationRulesResponse', describeClientVpnAuthorizationRulesResponse_authorizationRules - Information about the authorization rules.

DescribeClientVpnAuthorizationRules, describeClientVpnAuthorizationRulesResponse_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:DescribeClientVpnAuthorizationRulesResponse', describeClientVpnAuthorizationRulesResponse_httpStatus - The response's http status code.

Response Lenses

describeClientVpnAuthorizationRulesResponse_authorizationRules :: Lens' DescribeClientVpnAuthorizationRulesResponse (Maybe [AuthorizationRule]) Source #

Information about the authorization rules.

describeClientVpnAuthorizationRulesResponse_nextToken :: Lens' DescribeClientVpnAuthorizationRulesResponse (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.

describeClientVpnAuthorizationRulesResponse_httpStatus :: Lens' DescribeClientVpnAuthorizationRulesResponse Int Source #

The response's http status code.