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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.

Request Syntax

{ "associatedGatewayOwnerAccount": "string", "directConnectGatewayId": "string", "overrideAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "proposalId": "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.


The ID of the AWS account that owns the virtual private gateway or transit gateway.

Type: String

Required: Yes


The ID of the Direct Connect gateway.

Type: String

Required: Yes


Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

Type: Array of RouteFilterPrefix objects

Required: No


The ID of the request proposal.

Type: String

Required: Yes

Response Syntax

{ "directConnectGatewayAssociation": { "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" } }

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.


Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

Type: DirectConnectGatewayAssociation object


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


One or more parameters are not valid.

HTTP Status Code: 400


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: