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


Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.


Intended for use by AWS Direct Connect Partners only.

Request Syntax

{ "connectionId": "string", "parentConnectionId": "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 hosted connection.

Type: String

Required: Yes


The ID of the interconnect or the LAG.

Type: String

Required: Yes

Response Syntax

{ "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number }

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.


This parameter has been deprecated.

The Direct Connect endpoint on which the physical connection terminates.

Type: String


The Direct Connect endpoint on which the physical connection terminates.

Type: String


The bandwidth of the connection.

Type: String


The ID of the connection.

Type: String


The name of the connection.

Type: String


The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • pending: The connection has been approved and is being initialized.

  • available: The network link is up and the connection is ready for use.

  • down: The network link is down.

  • deleting: The connection is being deleted.

  • deleted: The connection has been deleted.

  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

  • unknown: The state of the connection is not available.

Type: String

Valid Values: ordering | requested | pending | available | down | deleting | deleted | rejected | unknown


Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

Type: String

Valid Values: unknown | yes | no


Indicates whether jumbo frames (9001 MTU) are supported.

Type: Boolean


The ID of the LAG.

Type: String


The time of the most recent call to DescribeLoa for this connection.

Type: Timestamp


The location of the connection.

Type: String


The ID of the AWS account that owns the connection.

Type: String


The name of the AWS Direct Connect service provider associated with the connection.

Type: String


The AWS Region where the connection is located.

Type: String


Any tags assigned to the connection.

Type: Array of Tag objects

Array Members: Minimum number of 1 item.


The ID of the VLAN.

Type: Integer


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: