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

Description

Describes the specified local gateway virtual interfaces.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeLocalGatewayVirtualInterfaces Source #

See: newDescribeLocalGatewayVirtualInterfaces smart constructor.

Constructors

DescribeLocalGatewayVirtualInterfaces' 

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.

    • local-address - The local address.
    • local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
    • local-gateway-id - The ID of the local gateway.
    • local-gateway-virtual-interface-id - The ID of the virtual interface.
    • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.
    • peer-address - The peer address.
    • peer-bgp-asn - The peer BGP ASN.
    • vlan - The ID of the VLAN.
  • localGatewayVirtualInterfaceIds :: Maybe [Text]

    The IDs of the virtual interfaces.

  • maxResults :: Maybe Natural

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • nextToken :: Maybe Text

    The token for the next page of results.

Instances

Instances details
ToHeaders DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

toHeaders :: DescribeLocalGatewayVirtualInterfaces -> [Header] #

ToPath DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

toPath :: DescribeLocalGatewayVirtualInterfaces -> ByteString #

ToQuery DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

toQuery :: DescribeLocalGatewayVirtualInterfaces -> QueryString #

AWSPager DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

page :: DescribeLocalGatewayVirtualInterfaces -> AWSResponse DescribeLocalGatewayVirtualInterfaces -> Maybe DescribeLocalGatewayVirtualInterfaces #

AWSRequest DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Associated Types

type AWSResponse DescribeLocalGatewayVirtualInterfaces #

Methods

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

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

Generic DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Associated Types

type Rep DescribeLocalGatewayVirtualInterfaces :: Type -> Type #

Methods

from :: DescribeLocalGatewayVirtualInterfaces -> Rep DescribeLocalGatewayVirtualInterfaces x #

to :: Rep DescribeLocalGatewayVirtualInterfaces x -> DescribeLocalGatewayVirtualInterfaces #

Read DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

readsPrec :: Int -> ReadS DescribeLocalGatewayVirtualInterfaces #

readList :: ReadS [DescribeLocalGatewayVirtualInterfaces] #

readPrec :: ReadPrec DescribeLocalGatewayVirtualInterfaces #

readListPrec :: ReadPrec [DescribeLocalGatewayVirtualInterfaces] #

Show DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

showsPrec :: Int -> DescribeLocalGatewayVirtualInterfaces -> ShowS #

show :: DescribeLocalGatewayVirtualInterfaces -> String #

showList :: [DescribeLocalGatewayVirtualInterfaces] -> ShowS #

NFData DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

rnf :: DescribeLocalGatewayVirtualInterfaces -> () #

Eq DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

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

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

Hashable DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

hashWithSalt :: Int -> DescribeLocalGatewayVirtualInterfaces -> Int #

hash :: DescribeLocalGatewayVirtualInterfaces -> Int #

type AWSResponse DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

type AWSResponse DescribeLocalGatewayVirtualInterfaces = DescribeLocalGatewayVirtualInterfacesResponse
type Rep DescribeLocalGatewayVirtualInterfaces Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

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

newDescribeLocalGatewayVirtualInterfaces :: DescribeLocalGatewayVirtualInterfaces Source #

Create a value of DescribeLocalGatewayVirtualInterfaces 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:DescribeLocalGatewayVirtualInterfaces', describeLocalGatewayVirtualInterfaces_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:DescribeLocalGatewayVirtualInterfaces', describeLocalGatewayVirtualInterfaces_filters - One or more filters.

  • local-address - The local address.
  • local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
  • local-gateway-id - The ID of the local gateway.
  • local-gateway-virtual-interface-id - The ID of the virtual interface.
  • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.
  • peer-address - The peer address.
  • peer-bgp-asn - The peer BGP ASN.
  • vlan - The ID of the VLAN.

DescribeLocalGatewayVirtualInterfaces, describeLocalGatewayVirtualInterfaces_localGatewayVirtualInterfaceIds - The IDs of the virtual interfaces.

$sel:maxResults:DescribeLocalGatewayVirtualInterfaces', describeLocalGatewayVirtualInterfaces_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

DescribeLocalGatewayVirtualInterfaces, describeLocalGatewayVirtualInterfaces_nextToken - The token for the next page of results.

Request Lenses

describeLocalGatewayVirtualInterfaces_dryRun :: Lens' DescribeLocalGatewayVirtualInterfaces (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.

describeLocalGatewayVirtualInterfaces_filters :: Lens' DescribeLocalGatewayVirtualInterfaces (Maybe [Filter]) Source #

One or more filters.

  • local-address - The local address.
  • local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
  • local-gateway-id - The ID of the local gateway.
  • local-gateway-virtual-interface-id - The ID of the virtual interface.
  • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.
  • peer-address - The peer address.
  • peer-bgp-asn - The peer BGP ASN.
  • vlan - The ID of the VLAN.

describeLocalGatewayVirtualInterfaces_localGatewayVirtualInterfaceIds :: Lens' DescribeLocalGatewayVirtualInterfaces (Maybe [Text]) Source #

The IDs of the virtual interfaces.

describeLocalGatewayVirtualInterfaces_maxResults :: Lens' DescribeLocalGatewayVirtualInterfaces (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

describeLocalGatewayVirtualInterfaces_nextToken :: Lens' DescribeLocalGatewayVirtualInterfaces (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeLocalGatewayVirtualInterfacesResponse Source #

See: newDescribeLocalGatewayVirtualInterfacesResponse smart constructor.

Constructors

DescribeLocalGatewayVirtualInterfacesResponse' 

Fields

Instances

Instances details
Generic DescribeLocalGatewayVirtualInterfacesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Associated Types

type Rep DescribeLocalGatewayVirtualInterfacesResponse :: Type -> Type #

Methods

from :: DescribeLocalGatewayVirtualInterfacesResponse -> Rep DescribeLocalGatewayVirtualInterfacesResponse x #

to :: Rep DescribeLocalGatewayVirtualInterfacesResponse x -> DescribeLocalGatewayVirtualInterfacesResponse #

Read DescribeLocalGatewayVirtualInterfacesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

readsPrec :: Int -> ReadS DescribeLocalGatewayVirtualInterfacesResponse #

readList :: ReadS [DescribeLocalGatewayVirtualInterfacesResponse] #

readPrec :: ReadPrec DescribeLocalGatewayVirtualInterfacesResponse #

readListPrec :: ReadPrec [DescribeLocalGatewayVirtualInterfacesResponse] #

Show DescribeLocalGatewayVirtualInterfacesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

showsPrec :: Int -> DescribeLocalGatewayVirtualInterfacesResponse -> ShowS #

show :: DescribeLocalGatewayVirtualInterfacesResponse -> String #

showList :: [DescribeLocalGatewayVirtualInterfacesResponse] -> ShowS #

NFData DescribeLocalGatewayVirtualInterfacesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

rnf :: DescribeLocalGatewayVirtualInterfacesResponse -> () #

Eq DescribeLocalGatewayVirtualInterfacesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

Methods

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

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

type Rep DescribeLocalGatewayVirtualInterfacesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaces

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

newDescribeLocalGatewayVirtualInterfacesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeLocalGatewayVirtualInterfacesResponse'

-> DescribeLocalGatewayVirtualInterfacesResponse 

Create a value of DescribeLocalGatewayVirtualInterfacesResponse 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:localGatewayVirtualInterfaces:DescribeLocalGatewayVirtualInterfacesResponse', describeLocalGatewayVirtualInterfacesResponse_localGatewayVirtualInterfaces - Information about the virtual interfaces.

DescribeLocalGatewayVirtualInterfaces, describeLocalGatewayVirtualInterfacesResponse_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:DescribeLocalGatewayVirtualInterfacesResponse', describeLocalGatewayVirtualInterfacesResponse_httpStatus - The response's http status code.

Response Lenses

describeLocalGatewayVirtualInterfacesResponse_localGatewayVirtualInterfaces :: Lens' DescribeLocalGatewayVirtualInterfacesResponse (Maybe [LocalGatewayVirtualInterface]) Source #

Information about the virtual interfaces.

describeLocalGatewayVirtualInterfacesResponse_nextToken :: Lens' DescribeLocalGatewayVirtualInterfacesResponse (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.

describeLocalGatewayVirtualInterfacesResponse_httpStatus :: Lens' DescribeLocalGatewayVirtualInterfacesResponse Int Source #

The response's http status code.