Describe Direct Connect Gateway Attachments

directconnect_describe_direct_connect_gateway_attachments

R Documentation

Lists the attachments between your Direct Connect gateways and virtual interfaces¶

Description¶

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

Usage¶

directconnect_describe_direct_connect_gateway_attachments(
  directConnectGatewayId, virtualInterfaceId, maxResults, nextToken)

Arguments¶

directConnectGatewayId

The ID of the Direct Connect gateway.

virtualInterfaceId

The ID of the virtual interface.

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.

If MaxResults is given a value larger than 100, only 100 results are returned.

nextToken

The token provided in the previous call to retrieve the next page.

Value¶

A list with the following syntax:

list(
  directConnectGatewayAttachments = list(
    list(
      directConnectGatewayId = "string",
      virtualInterfaceId = "string",
      virtualInterfaceRegion = "string",
      virtualInterfaceOwnerAccount = "string",
      attachmentState = "attaching"|"attached"|"detaching"|"detached",
      attachmentType = "TransitVirtualInterface"|"PrivateVirtualInterface",
      stateChangeError = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$describe_direct_connect_gateway_attachments(
  directConnectGatewayId = "string",
  virtualInterfaceId = "string",
  maxResults = 123,
  nextToken = "string"
)