paws.networking: directconnect_describe_virtual_interfaces – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

directconnect_describe_virtual_interfaces

Displays all virtual interfaces for an AWS account

Description

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer network.

Usage

directconnect_describe_virtual_interfaces(connectionId,
  virtualInterfaceId)

Arguments

`connectionId`	The ID of the connection.
`virtualInterfaceId`	The ID of the virtual interface.

Value

A list with the following syntax:

list(
  virtualInterfaces = list(
    list(
      ownerAccount = "string",
      virtualInterfaceId = "string",
      location = "string",
      connectionId = "string",
      virtualInterfaceType = "string",
      virtualInterfaceName = "string",
      vlan = 123,
      asn = 123,
      amazonSideAsn = 123,
      authKey = "string",
      amazonAddress = "string",
      customerAddress = "string",
      addressFamily = "ipv4"|"ipv6",
      virtualInterfaceState = "confirming"|"verifying"|"pending"|"available"|"down"|"deleting"|"deleted"|"rejected"|"unknown",
      customerRouterConfig = "string",
      mtu = 123,
      jumboFrameCapable = TRUE|FALSE,
      virtualGatewayId = "string",
      directConnectGatewayId = "string",
      routeFilterPrefixes = list(
        list(
          cidr = "string"
        )
      ),
      bgpPeers = list(
        list(
          bgpPeerId = "string",
          asn = 123,
          authKey = "string",
          addressFamily = "ipv4"|"ipv6",
          amazonAddress = "string",
          customerAddress = "string",
          bgpPeerState = "verifying"|"pending"|"available"|"deleting"|"deleted",
          bgpStatus = "up"|"down"|"unknown",
          awsDeviceV2 = "string"
        )
      ),
      region = "string",
      awsDeviceV2 = "string",
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      )
    )
  )
)

Request syntax

svc$describe_virtual_interfaces(
  connectionId = "string",
  virtualInterfaceId = "string"
)

paws.networking

Amazon Web Services Networking & Content Delivery Services

v0.1.11

Apache License (>= 2.0)

Authors

David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]

Initial release