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

DescribeDirectConnectGatewayAssociations

Returns a list of all direct connect gateway and virtual private gateway (VGW) associations. Either a direct connect gateway ID or a VGW ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VGWs associated with the direct connect gateway. If a VGW ID is provided, the response returns all direct connect gateways associated with the VGW. If both are provided, the response only returns the association that matches both the direct connect gateway and the VGW.

Request Syntax

{ "directConnectGatewayId": "string", "maxResults": number, "nextToken": "string", "virtualGatewayId": "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 gateway associations 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

virtualGatewayId

The ID of the virtual private gateway.

Example: "vgw-abc123ef"

Default: None

Type: String

Required: No

Response Syntax

{ "directConnectGatewayAssociations": [ { "associationState": "string", "directConnectGatewayId": "string", "stateChangeError": "string", "virtualGatewayId": "string", "virtualGatewayOwnerAccount": "string", "virtualGatewayRegion": "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.

directConnectGatewayAssociations

Information about the direct connect gateway associations.

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