Describes all your link aggregation groups (LAG) or the specified LAG¶

Description¶

Describes all your link aggregation groups (LAG) or the specified LAG.

Usage¶

directconnect_describe_lags(lagId, maxResults, nextToken)

Arguments¶

lagId

The ID of the 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(
  lags = list(
    list(
      connectionsBandwidth = "string",
      numberOfConnections = 123,
      lagId = "string",
      ownerAccount = "string",
      lagName = "string",
      lagState = "requested"|"pending"|"available"|"down"|"deleting"|"deleted"|"unknown",
      location = "string",
      region = "string",
      minimumLinks = 123,
      awsDevice = "string",
      awsDeviceV2 = "string",
      awsLogicalDeviceId = "string",
      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"
            )
          ),
          rateLimiterStatus = list(
            maxAllowed = 123,
            inUse = 123,
            remaining = 123,
            totalBandwidth = "string"
          ),
          partnerInterconnectMacSecCapable = TRUE|FALSE,
          prefixPoolSizeIpv4 = 123,
          prefixPoolSizeIpv6 = 123,
          prefixPoolUnallocatedCountIpv4 = 123,
          prefixPoolUnallocatedCountIpv6 = 123,
          billingMode = "PayAsYouGo"|"FlatRateTier1"|"FlatRateTier2"|"FlatRateTier3"|"FlatRateTier4"|"FlatRateTier5"|"PortPairFlatRateTier1"|"PortPairFlatRateTier2"|"PortPairFlatRateTier3"|"PortPairFlatRateTier4"|"PortPairFlatRateTier5"
        )
      ),
      allowsHostedConnections = TRUE|FALSE,
      jumboFrameCapable = TRUE|FALSE,
      hasLogicalRedundancy = "unknown"|"yes"|"no",
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      providerName = "string",
      macSecCapable = TRUE|FALSE,
      encryptionMode = "string",
      macSecKeys = list(
        list(
          secretARN = "string",
          ckn = "string",
          state = "string",
          startOn = "string"
        )
      ),
      prefixPoolSizeIpv4 = 123,
      prefixPoolSizeIpv6 = 123,
      prefixPoolUnallocatedCountIpv4 = 123,
      prefixPoolUnallocatedCountIpv6 = 123,
      rateLimiterStatus = list(
        maxAllowed = 123,
        inUse = 123,
        remaining = 123,
        totalBandwidth = "string"
      ),
      billingMode = "PayAsYouGo"|"FlatRateTier1"|"FlatRateTier2"|"FlatRateTier3"|"FlatRateTier4"|"FlatRateTier5"|"PortPairFlatRateTier1"|"PortPairFlatRateTier2"|"PortPairFlatRateTier3"|"PortPairFlatRateTier4"|"PortPairFlatRateTier5"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$describe_lags(
  lagId = "string",
  maxResults = 123,
  nextToken = "string"
)