Lists all your Direct Connect gateways or only the specified Direct Connect gateway¶

Description¶

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

Usage¶

directconnect_describe_direct_connect_gateways(directConnectGatewayId,
  maxResults, nextToken)

Arguments¶

directConnectGatewayId

The ID of the Direct Connect gateway.
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(
  directConnectGateways = list(
    list(
      directConnectGatewayId = "string",
      directConnectGatewayName = "string",
      amazonSideAsn = 123,
      ownerAccount = "string",
      directConnectGatewayState = "pending"|"available"|"deleting"|"deleted",
      stateChangeError = "string",
      totalPrefixPoolAllocations = 123,
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

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