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

DescribeDirectConnectGatewayAttachments

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

Request Syntax

{ "directConnectGatewayId": "string", "maxResults": number, "nextToken": "string", "virtualInterfaceId": "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 attachments to return per page.

Type: Integer

Required: No

nextToken

The token provided in the previous call to retrieve the next page.

Type: String

Required: No

virtualInterfaceId

The ID of the virtual interface.

Type: String

Required: No

Response Syntax

{ "directConnectGatewayAttachments": [ { "attachmentState": "string", "directConnectGatewayId": "string", "stateChangeError": "string", "virtualInterfaceId": "string", "virtualInterfaceOwnerAccount": "string", "virtualInterfaceRegion": "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.

directConnectGatewayAttachments

The attachments.

Type: Array of DirectConnectGatewayAttachment 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: