DescribeLocalGatewayVirtualInterfaces
Describes the specified local gateway virtual interfaces.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- 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 isUnauthorizedOperation.Type: Boolean
Required: No
- Filter.N
-
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 AWS 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.
Type: Array of Filter objects
Required: No
-
- LocalGatewayVirtualInterfaceId.N
-
The IDs of the virtual interfaces.
Type: Array of strings
Required: No
- MaxResults
-
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextTokenvalue.Type: Integer
Valid Range: Minimum value of 5. Maximum value of 1000.
Required: No
- NextToken
-
The token for the next page of results.
Type: String
Required: No
Response Elements
The following elements are returned by the service.
- localGatewayVirtualInterfaceSet
-
Information about the virtual interfaces.
Type: Array of LocalGatewayVirtualInterface objects
- nextToken
-
The token to use to retrieve the next page of results. This value is
nullwhen there are no more results to return.Type: String
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
