Describes the specified local gateway virtual interfaces¶

Description¶

Describes the specified local gateway virtual interfaces.

Usage¶

ec2_describe_local_gateway_virtual_interfaces(
  LocalGatewayVirtualInterfaceIds, Filters, MaxResults, NextToken, DryRun)

Arguments¶

• LocalGatewayVirtualInterfaceIds

  The IDs of the virtual interfaces.

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

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

• NextToken

  The token for the next page of results.

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

Value¶

A list with the following syntax:

list(
  LocalGatewayVirtualInterfaces = list(
    list(
      LocalGatewayVirtualInterfaceId = "string",
      LocalGatewayId = "string",
      LocalGatewayVirtualInterfaceGroupId = "string",
      LocalGatewayVirtualInterfaceArn = "string",
      OutpostLagId = "string",
      Vlan = 123,
      LocalAddress = "string",
      PeerAddress = "string",
      LocalBgpAsn = 123,
      PeerBgpAsn = 123,
      PeerBgpAsnExtended = 123,
      OwnerId = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      ConfigurationState = "pending"|"available"|"deleting"|"deleted"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_local_gateway_virtual_interfaces(
  LocalGatewayVirtualInterfaceIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  DryRun = TRUE|FALSE
)