directconnect_describe_direct_connect_gateways: Lists all your Direct Connect gateways or only the specified...

Description Usage Arguments Value Request syntax

View source: R/directconnect_operations.R

Description

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

Usage

1
2
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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
list(
  directConnectGateways = list(
    list(
      directConnectGatewayId = "string",
      directConnectGatewayName = "string",
      amazonSideAsn = 123,
      ownerAccount = "string",
      directConnectGatewayState = "pending"|"available"|"deleting"|"deleted",
      stateChangeError = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

1
2
3
4
5
svc$describe_direct_connect_gateways(
  directConnectGatewayId = "string",
  maxResults = 123,
  nextToken = "string"
)

paws.networking documentation built on March 7, 2021, 5:08 p.m.