DescribeDirectConnectGateways
Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not 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.
Type: String
Required: No
- maxResults
-
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextTokenvalue.If
MaxResultsis given a value larger than 100, only 100 results are returned.Type: Integer
Required: No
- nextToken
-
The token provided in the previous call to retrieve the next page.
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
-
The Direct Connect gateways.
Type: Array of DirectConnectGateway objects
- nextToken
-
The token to retrieve the next page.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- DirectConnectClientException
-
One or more parameters are not valid.
HTTP Status Code: 400
- DirectConnectServerException
-
A server-side error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
