AWS Direct Connect
API Reference (API Version 2012-10-25)
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

DescribeDirectConnectGatewayAssociations

Lists the associations between your Direct Connect gateways and virtual private gateways. You must specify a Direct Connect gateway, a virtual private gateway, or both. If you specify a Direct Connect gateway, the response contains all virtual private gateways associated with the Direct Connect gateway. If you specify a virtual private gateway, the response contains all Direct Connect gateways associated with the virtual private gateway. If you specify both, the response contains the association between the Direct Connect gateway and the virtual private gateway.

Request Syntax

{ "associatedGatewayId": "string", "associationId": "string", "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.

associatedGatewayId

The ID of the associated gateway.

Type: String

Required: No

associationId

The ID of the Direct Connect gateway association.

Type: String

Required: No

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 nextToken value.

If MaxResults is 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

virtualGatewayId

This parameter has been deprecated.

The ID of the virtual private gateway.

Type: String

Required: No

Response Syntax

{ "directConnectGatewayAssociations": [ { "allowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "associatedGateway": { "id": "string", "ownerAccount": "string", "region": "string", "type": "string" }, "associationId": "string", "associationState": "string", "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "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 associations.

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