Menu
AWS Direct Connect
API Reference (API Version 2012-10-25)

DescribeDirectConnectGateways

Returns a list of direct connect gateways in your account. Deleted direct connect gateways are not returned. You can provide a direct connect gateway ID in the request to return information about the specific direct connect gateway only. Otherwise, if a direct connect gateway ID is not provided, information about all of your direct connect gateways is returned.

Request Syntax

{ "directConnectGatewayId": "string", "maxResults": number, "nextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

directConnectGatewayId

The ID of the direct connect gateway.

Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

Default: None

Type: String

Required: No

maxResults

The maximum number of direct connect gateways to return per page.

Example: 15

Default: None

Type: Integer

Required: No

nextToken

The token provided in the previous describe result to retrieve the next page of the result.

Default: None

Type: String

Required: No

Response Syntax

{ "directConnectGateways": [ { "amazonSideAsn": number, "directConnectGatewayId": "string", "directConnectGatewayName": "string", "directConnectGatewayState": "string", "ownerAccount": "string", "stateChangeError": "string" } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

directConnectGateways

Information about the direct connect gateways.

Type: Array of DirectConnectGateway objects

nextToken

Token to retrieve the next page of the result.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DirectConnectClientException

The API was called with invalid parameters. The error message will contain additional details about the cause.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred during the API call. The error message will contain additional details about the cause.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: