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.


Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

Request Syntax

{ "associatedGatewayId": "string", "directConnectGatewayId": "string", "maxResults": number, "nextToken": "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 associated gateway.

Type: String

Required: No


The ID of the Direct Connect gateway.

Type: String

Required: No


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


The token for the next page of results.

Type: String

Required: No


The ID of the proposal.

Type: String

Required: No

Response Syntax

{ "directConnectGatewayAssociationProposals": [ { "associatedGateway": { "id": "string", "ownerAccount": "string", "region": "string", "type": "string" }, "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "string", "existingAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "proposalId": "string", "proposalState": "string", "requestedAllowedPrefixesToDirectConnectGateway": [ { "cidr": "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.


Describes the Direct Connect gateway association proposals.

Type: Array of DirectConnectGatewayAssociationProposal objects


The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String


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: