Describe Hosted Connections

directconnect_describe_hosted_connections

R Documentation

Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG)¶

Description¶

Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).

Intended for use by Direct Connect Partners only.

Usage¶

directconnect_describe_hosted_connections(connectionId, maxResults,
  nextToken)

Arguments¶

connectionId

[required] The ID of the interconnect or LAG.

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(
  connections = list(
    list(
      ownerAccount = "string",
      connectionId = "string",
      connectionName = "string",
      connectionState = "ordering"|"requested"|"pending"|"available"|"down"|"deleting"|"deleted"|"rejected"|"unknown",
      region = "string",
      location = "string",
      bandwidth = "string",
      vlan = 123,
      partnerName = "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"
        )
      ),
      partnerInterconnectMacSecCapable = TRUE|FALSE
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$describe_hosted_connections(
  connectionId = "string",
  maxResults = 123,
  nextToken = "string"
)