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 |
Describes the specified local gateway virtual interfaces.
This operation returns paginated results.
Synopsis
- data DescribeLocalGatewayVirtualInterfaces = DescribeLocalGatewayVirtualInterfaces' {}
- newDescribeLocalGatewayVirtualInterfaces :: DescribeLocalGatewayVirtualInterfaces
- describeLocalGatewayVirtualInterfaces_dryRun :: Lens' DescribeLocalGatewayVirtualInterfaces (Maybe Bool)
- describeLocalGatewayVirtualInterfaces_filters :: Lens' DescribeLocalGatewayVirtualInterfaces (Maybe [Filter])
- describeLocalGatewayVirtualInterfaces_localGatewayVirtualInterfaceIds :: Lens' DescribeLocalGatewayVirtualInterfaces (Maybe [Text])
- describeLocalGatewayVirtualInterfaces_maxResults :: Lens' DescribeLocalGatewayVirtualInterfaces (Maybe Natural)
- describeLocalGatewayVirtualInterfaces_nextToken :: Lens' DescribeLocalGatewayVirtualInterfaces (Maybe Text)
- data DescribeLocalGatewayVirtualInterfacesResponse = DescribeLocalGatewayVirtualInterfacesResponse' {}
- newDescribeLocalGatewayVirtualInterfacesResponse :: Int -> DescribeLocalGatewayVirtualInterfacesResponse
- describeLocalGatewayVirtualInterfacesResponse_localGatewayVirtualInterfaces :: Lens' DescribeLocalGatewayVirtualInterfacesResponse (Maybe [LocalGatewayVirtualInterface])
- describeLocalGatewayVirtualInterfacesResponse_nextToken :: Lens' DescribeLocalGatewayVirtualInterfacesResponse (Maybe Text)
- describeLocalGatewayVirtualInterfacesResponse_httpStatus :: Lens' DescribeLocalGatewayVirtualInterfacesResponse Int
Creating a Request
data DescribeLocalGatewayVirtualInterfaces Source #
See: newDescribeLocalGatewayVirtualInterfaces
smart constructor.
DescribeLocalGatewayVirtualInterfaces' | |
|
Instances
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.
DescribeLocalGatewayVirtualInterfacesResponse' | |
|
Instances
newDescribeLocalGatewayVirtualInterfacesResponse Source #
:: Int |
|
-> 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.