Skip to content

Describe Interconnects

directconnect_describe_interconnects R Documentation

Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect

Description

Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.

Usage

directconnect_describe_interconnects(interconnectId, maxResults,
  nextToken)

Arguments

interconnectId

The ID of the interconnect.

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 for the next page of results.

Value

A list with the following syntax:

list(
  interconnects = list(
    list(
      interconnectId = "string",
      interconnectName = "string",
      interconnectState = "requested"|"pending"|"available"|"down"|"deleting"|"deleted"|"unknown",
      region = "string",
      location = "string",
      bandwidth = "string",
      loaIssueTime = as.POSIXct(
        "2015-01-01"
      ),
      lagId = "string",
      awsDevice = "string",
      jumboFrameCapable = TRUE|FALSE,
      awsDeviceV2 = "string",
      awsLogicalDeviceId = "string",
      hasLogicalRedundancy = "unknown"|"yes"|"no",
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      providerName = "string",
      macSecCapable = TRUE|FALSE,
      portEncryptionStatus = "string",
      encryptionMode = "string",
      macSecKeys = list(
        list(
          secretARN = "string",
          ckn = "string",
          state = "string",
          startOn = "string"
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_interconnects(
  interconnectId = "string",
  maxResults = 123,
  nextToken = "string"
)