AWS Direct Connect

(1)

AWS Direct Connect

API Reference

API Version 2012-10-25

(2)

AWS Direct Connect: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard Ethernet ﬁber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. With this connection in place, you can create virtual interfaces directly to the AWS Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all AWS Regions except the China (Beijing) and (China) Ningxia Regions. AWS resources in the China Regions can only be accessed through locations associated with those Regions.

This document was last published on March 6, 2022.

(14)

Actions

The following actions are supported:

• AcceptDirectConnectGatewayAssociationProposal (p. 4)

• AllocateConnectionOnInterconnect (p. 7)

• AllocateHostedConnection (p. 12)

• AllocatePrivateVirtualInterface (p. 18)

• AllocatePublicVirtualInterface (p. 24)

• AllocateTransitVirtualInterface (p. 30)

• AssociateConnectionWithLag (p. 33)

• AssociateHostedConnection (p. 38)

• AssociateMacSecKey (p. 43)

• AssociateVirtualInterface (p. 46)

• ConﬁrmConnection (p. 52)

• ConﬁrmCustomerAgreement (p. 54)

• ConﬁrmPrivateVirtualInterface (p. 56)

• ConﬁrmPublicVirtualInterface (p. 59)

• ConﬁrmTransitVirtualInterface (p. 61)

• CreateBGPPeer (p. 63)

• CreateConnection (p. 66)

• CreateDirectConnectGateway (p. 72)

• CreateDirectConnectGatewayAssociation (p. 74)

• CreateDirectConnectGatewayAssociationProposal (p. 77)

• CreateInterconnect (p. 80)

• CreateLag (p. 85)

• CreatePrivateVirtualInterface (p. 92)

• CreatePublicVirtualInterface (p. 98)

• CreateTransitVirtualInterface (p. 104)

• DeleteBGPPeer (p. 107)

• DeleteConnection (p. 110)

• DeleteDirectConnectGateway (p. 115)

• DeleteDirectConnectGatewayAssociation (p. 117)

• DeleteDirectConnectGatewayAssociationProposal (p. 120)

• DeleteInterconnect (p. 122)

• DeleteLag (p. 124)

• DeleteVirtualInterface (p. 129)

• DescribeConnectionLoa (p. 131)

• DescribeConnections (p. 133)

• DescribeConnectionsOnInterconnect (p. 135)

• DescribeCustomerMetadata (p. 138)

• DescribeDirectConnectGatewayAssociationProposals (p. 140)

• DescribeDirectConnectGatewayAssociations (p. 143)

• DescribeDirectConnectGatewayAttachments (p. 146)

(15)

• DescribeDirectConnectGateways (p. 149)

• DescribeHostedConnections (p. 151)

• DescribeInterconnectLoa (p. 154)

• DescribeInterconnects (p. 156)

• DescribeLags (p. 158)

• DescribeLoa (p. 161)

• DescribeLocations (p. 163)

• DescribeRouterConﬁguration (p. 165)

• DescribeTags (p. 167)

• DescribeVirtualGateways (p. 169)

• DescribeVirtualInterfaces (p. 171)

• DisassociateConnectionFromLag (p. 174)

• DisassociateMacSecKey (p. 179)

• ListVirtualInterfaceTestHistory (p. 181)

• StartBgpFailoverTest (p. 184)

• StopBgpFailoverTest (p. 186)

• TagResource (p. 188)

• UntagResource (p. 190)

• UpdateConnection (p. 192)

• UpdateDirectConnectGateway (p. 197)

• UpdateDirectConnectGatewayAssociation (p. 199)

• UpdateLag (p. 202)

• UpdateVirtualInterfaceAttributes (p. 208)

(16)

AcceptDirectConnectGatewayAssociationProposal

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 (p. 268).

The request accepts the following data in JSON format.

associatedGatewayOwnerAccount (p. 4)

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

Type: String Required: Yes

directConnectGatewayId (p. 4)

The ID of the Direct Connect gateway.

overrideAllowedPreﬁxesToDirectConnectGateway (p. 4)

Overrides the Amazon VPC preﬁxes advertised to the Direct Connect gateway.

For information about how to set the preﬁxes, see Allowed Preﬁxes in the AWS Direct Connect User Guide.

Type: Array of RouteFilterPreﬁx (p. 257) objects Required: No

proposalId (p. 4)

The ID of the request proposal.

(17)

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.

directConnectGatewayAssociation (p. 5)

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

Type: DirectConnectGatewayAssociation (p. 225) object

Errors

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

DirectConnectClientException

One or more parameters are not valid.

HTTP Status Code: 400 DirectConnectServerException

A server-side error occurred.

HTTP Status Code: 400

AllocateConnectionOnInterconnect

Deprecated. Use AllocateHostedConnection (p. 12) instead.

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a speciﬁed amount of bandwidth for use by a hosted connection on the speciﬁed interconnect.

Note

Intended for use by AWS Direct Connect Partners only.

Request Syntax

{ "bandwidth": "string", "connectionName": "string", "interconnectId": "string", "ownerAccount": "string", "vlan": number

}

Request Parameters

bandwidth (p. 7)

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met speciﬁc requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

Type: String Required: Yes connectionName (p. 7)

The name of the provisioned connection.

Type: String Required: Yes interconnectId (p. 7)

The ID of the interconnect on which the connection will be provisioned.

Type: String Required: Yes ownerAccount (p. 7)

The ID of the AWS account of the customer for whom the connection will be provisioned.

Type: String

(20)

Response Syntax

Required: Yes vlan (p. 7)

The dedicated VLAN provisioned to the connection.

Type: Integer Required: Yes

Response Syntax

{

"awsDevice": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bandwidth": "string",

"connectionId": "string", "connectionName": "string", "connectionState": "string", "encryptionMode": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string",

"loaIssueTime": number, "location": "string", "macSecCapable": boolean, "macSecKeys": [

{

"ckn": "string", "secretARN": "string", "startOn": "string", "state": "string"

} ],

"ownerAccount": "string", "partnerName": "string",

"portEncryptionStatus": "string", "providerName": "string",

"region": "string", "tags": [

{

"key": "string", "value": "string"

} ],

"vlan": number }

Response Elements

awsDevice (p. 8)

This parameter has been deprecated.

The Direct Connect endpoint on which the physical connection terminates.

(21)

Response Elements

Type: String awsDeviceV2 (p. 8)

The Direct Connect endpoint that terminates the physical connection.

Type: String

awsLogicalDeviceId (p. 8)

The Direct Connect endpoint that terminates the logical connection. This device might be diﬀerent than the device that terminates the physical connection.

Type: String bandwidth (p. 8)

The bandwidth of the connection.

Type: String connectionId (p. 8)

The ID of the connection.

Type: String connectionName (p. 8)

The name of the connection.

Type: String connectionState (p. 8)

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 conﬁrms 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

encryptionMode (p. 8)

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

Type: String

(22)

Response Elements

hasLogicalRedundancy (p. 8)

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

IPv6).

Type: String

Valid Values: unknown | yes | no jumboFrameCapable (p. 8)

Indicates whether jumbo frames (9001 MTU) are supported.

Type: Boolean lagId (p. 8)

The ID of the LAG.

Type: String loaIssueTime (p. 8)

The time of the most recent call to DescribeLoa (p. 161) for this connection.

Type: Timestamp location (p. 8)

The location of the connection.

Type: String macSecCapable (p. 8)

Indicates whether the connection supports MAC Security (MACsec).

Type: Boolean macSecKeys (p. 8)

The MAC Security (MACsec) security keys associated with the connection.

Type: Array of MacSecKey (p. 241) objects ownerAccount (p. 8)

The ID of the AWS account that owns the connection.

Type: String partnerName (p. 8)

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

Type: String

portEncryptionStatus (p. 8)

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

Type: String providerName (p. 8)

The name of the service provider associated with the connection.

(23)

Errors

Type: String region (p. 8)

The AWS Region where the connection is located.

Type: String tags (p. 8)

The tags associated with the connection.

Type: Array of Tag (p. 260) objects

Array Members: Minimum number of 1 item.

vlan (p. 8)

The ID of the VLAN.

Type: Integer

Errors

AllocateHostedConnection

Creates a hosted connection on the speciﬁed interconnect or a link aggregation group (LAG) of interconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity.

NoteIntended for use by AWS Direct Connect Partners only.

Request Syntax

{ "bandwidth": "string", "connectionId": "string", "connectionName": "string", "ownerAccount": "string", "tags": [

{

} ],

"vlan": number }

Request Parameters

bandwidth (p. 12)

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met speciﬁc requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

Type: String Required: Yes connectionId (p. 12)

The ID of the interconnect or LAG.

Type: String Required: Yes connectionName (p. 12)

The name of the hosted connection.

Type: String

(25)

Response Syntax

Required: Yes ownerAccount (p. 12)

The ID of the AWS account ID of the customer for the connection.

Type: String Required: Yes tags (p. 12)

Required: No vlan (p. 12)

The dedicated VLAN provisioned to the hosted connection.

Type: Integer Required: Yes

Response Syntax

{ "awsDevice": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bandwidth": "string",

"connectionId": "string", "connectionName": "string", "connectionState": "string", "encryptionMode": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string",

{

} ],

{

} ],

(26)

Response Elements

"vlan": number }

Response Elements

Type: String

Type: String connectionId (p. 13)

Type: String

connectionName (p. 13)

(27)

Response Elements

Type: String

IPv6).

Type: String

The ID of the LAG.

Type: String loaIssueTime (p. 13)

The time of the most recent call to DescribeLoa (p. 161) for this connection.

Type: Timestamp location (p. 13)

Type: String macSecCapable (p. 13)

Indicates whether the connection supports MAC Security (MACsec).

Type: Boolean macSecKeys (p. 13)

The MAC Security (MACsec) security keys associated with the connection.

Type: Array of MacSecKey (p. 241) objects ownerAccount (p. 13)

The ID of the AWS account that owns the connection.

Type: String

(28)

Errors

partnerName (p. 13)

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

Type: String

portEncryptionStatus (p. 13)

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

Type: String providerName (p. 13)

The name of the service provider associated with the connection.

The AWS Region where the connection is located.

Type: String tags (p. 13)

vlan (p. 13)

The ID of the VLAN.

Type: Integer

Errors

HTTP Status Code: 400 DuplicateTagKeysException

A tag key was speciﬁed more than once.

HTTP Status Code: 400 TooManyTagsException

You have reached the limit on the number of tags that can be assigned.

(29)

AllocatePrivateVirtualInterface

Provisions a private virtual interface to be owned by the speciﬁed AWS account.

Virtual interfaces created using this action must be conﬁrmed by the owner using

ConﬁrmPrivateVirtualInterface (p. 56). Until then, the virtual interface is in the Confirming state and is not available to handle traﬃc.

Request Syntax

{ "connectionId": "string",

"newPrivateVirtualInterfaceAllocation": { "addressFamily": "string",

"amazonAddress": "string", "asn": number,

"authKey": "string",

"customerAddress": "string", "mtu": number,

"tags": [ {

} ],

"virtualInterfaceName": "string", "vlan": number

},

"ownerAccount": "string"

}

Request Parameters

connectionId (p. 18)

The ID of the connection on which the private virtual interface is provisioned.

newPrivateVirtualInterfaceAllocation (p. 18) Information about the private virtual interface.

Type: NewPrivateVirtualInterfaceAllocation (p. 246) object Required: Yes

ownerAccount (p. 18)

The ID of the AWS account that owns the virtual private interface.

(31)

Response Syntax

{

"addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number,

"authKey": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bgpPeers": [

{

"addressFamily": "string", "amazonAddress": "string", "asn": number,

"authKey": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bgpPeerId": "string",

"bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string"

} ],

"connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string",

"mtu": number,

"ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ {

"cidr": "string"

} ],

"siteLinkEnabled": boolean, "tags": [

{

} ],

"virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number

}

Response Elements

addressFamily (p. 19)

The address family for the BGP peer.

(32)

Response Elements

Type: String

Valid Values: ipv4 | ipv6 amazonAddress (p. 19)

The IP address assigned to the Amazon interface.

Type: String amazonSideAsn (p. 19)

The autonomous system number (ASN) for the Amazon side of the connection.

Type: Long asn (p. 19)

The autonomous system (AS) number for Border Gateway Protocol (BGP) conﬁguration.

The valid values are 1-2147483647.

Type: Integer authKey (p. 19)

The authentication key for BGP conﬁguration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

Type: String

Type: String bgpPeers (p. 19)

The BGP peers conﬁgured on this virtual interface.

Type: Array of BGPPeer (p. 216) objects connectionId (p. 19)

Type: String

customerAddress (p. 19)

The IP address assigned to the customer interface.

Type: String

customerRouterConﬁg (p. 19)

The customer router conﬁguration.

Type: String

(33)

Response Elements

Type: String

jumboFrameCapable (p. 19)

Type: Boolean location (p. 19)

Type: String mtu (p. 19)

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

Type: Integer ownerAccount (p. 19)

The ID of the AWS account that owns the virtual interface.

The AWS Region where the virtual interface is located.

Type: String

routeFilterPreﬁxes (p. 19)

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

Type: Array of RouteFilterPreﬁx (p. 257) objects siteLinkEnabled (p. 19)

Indicates whether SiteLink is enabled.

Type: Boolean tags (p. 19)

The tags associated with the virtual interface.

virtualGatewayId (p. 19)

The ID of the virtual private gateway. Applies only to private virtual interfaces.

Type: String

virtualInterfaceId (p. 19)

The ID of the virtual interface.

Type: String

(34)

Errors

virtualInterfaceName (p. 19)

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

Type: String

virtualInterfaceState (p. 19)

The state of the virtual interface. The following are the possible values:

• confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

• verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

• pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traﬃc.

• available: A virtual interface that is able to forward traﬃc.

• down: A virtual interface that is BGP down.

• deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface (p. 129) until it can no longer forward traﬃc.

• deleted: A virtual interface that cannot forward traﬃc.

• rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

• unknown: The state of the virtual interface is not available.

Type: String

virtualInterfaceType (p. 19)

The type of virtual interface. The possible values are private and public.

Type: String vlan (p. 19)

The ID of the VLAN.

Type: Integer

Errors

(35)

AllocatePublicVirtualInterface

Provisions a public virtual interface to be owned by the speciﬁed AWS account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the speciﬁed AWS account.

Virtual interfaces created using this function must be conﬁrmed by the owner using

ConﬁrmPublicVirtualInterface (p. 59). Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traﬃc.

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

Request Syntax

{

"connectionId": "string",

"newPublicVirtualInterfaceAllocation": { "addressFamily": "string",

"customerAddress": "string", "routeFilterPrefixes": [ {

"cidr": "string"

} ],

"tags": [ {

} ],

},

}

Request Parameters

The ID of the connection on which the public virtual interface is provisioned.

newPublicVirtualInterfaceAllocation (p. 24) Information about the public virtual interface.

(37)

Response Syntax

Type: NewPublicVirtualInterfaceAllocation (p. 250) object Required: Yes

The ID of the AWS account that owns the public virtual interface.

Response Syntax

{ "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number,

"authKey": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bgpPeers": [

{

} ],

"mtu": number,

"cidr": "string"

} ],

{

} ],

(38)

Response Elements

}

Response Elements

addressFamily (p. 25)

The address family for the BGP peer.

Type: String

Valid Values: ipv4 | ipv6 amazonAddress (p. 25)

The IP address assigned to the Amazon interface.

Type: String amazonSideAsn (p. 25)

The autonomous system number (ASN) for the Amazon side of the connection.

Type: Long asn (p. 25)

The autonomous system (AS) number for Border Gateway Protocol (BGP) conﬁguration.

The valid values are 1-2147483647.

Type: Integer authKey (p. 25)

The authentication key for BGP conﬁguration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

Type: String

Type: String bgpPeers (p. 25)

The BGP peers conﬁgured on this virtual interface.

Type: Array of BGPPeer (p. 216) objects connectionId (p. 25)

(39)

Response Elements

Type: String

customerAddress (p. 25)

The IP address assigned to the customer interface.

Type: String

customerRouterConﬁg (p. 25)

The customer router conﬁguration.

Type: String

jumboFrameCapable (p. 25)

Type: Boolean location (p. 25)

Type: String mtu (p. 25)

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

Type: Integer ownerAccount (p. 25)

The ID of the AWS account that owns the virtual interface.

The AWS Region where the virtual interface is located.

Type: String

routeFilterPreﬁxes (p. 25)

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

Type: Array of RouteFilterPreﬁx (p. 257) objects siteLinkEnabled (p. 25)

Indicates whether SiteLink is enabled.

Type: Boolean tags (p. 25)

The tags associated with the virtual interface.

(40)

Errors

virtualGatewayId (p. 25)

The ID of the virtual private gateway. Applies only to private virtual interfaces.

Type: String

virtualInterfaceId (p. 25)

The ID of the virtual interface.

Type: String

virtualInterfaceName (p. 25)

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

Type: String

virtualInterfaceState (p. 25)

The state of the virtual interface. The following are the possible values:

• confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

• verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

• pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traﬃc.

• available: A virtual interface that is able to forward traﬃc.

• down: A virtual interface that is BGP down.

• deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface (p. 129) until it can no longer forward traﬃc.

• deleted: A virtual interface that cannot forward traﬃc.

• rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

• unknown: The state of the virtual interface is not available.

Type: String

virtualInterfaceType (p. 25)

The type of virtual interface. The possible values are private and public.

Type: String vlan (p. 25)

The ID of the VLAN.

Type: Integer

Errors

(41)

AllocateTransitVirtualInterface

Provisions a transit virtual interface to be owned by the speciﬁed AWS account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the speciﬁed AWS account.

After you create a transit virtual interface, it must be conﬁrmed by the owner using

ConﬁrmTransitVirtualInterface (p. 61). Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traﬃc.

Request Syntax

{ "connectionId": "string",

"newTransitVirtualInterfaceAllocation": { "addressFamily": "string",

"customerAddress": "string", "mtu": number,

"tags": [ {

} ],

},

}

Request Parameters

The ID of the connection on which the transit virtual interface is provisioned.

newTransitVirtualInterfaceAllocation (p. 30)

Information about the transit virtual interface.

Type: NewTransitVirtualInterfaceAllocation (p. 254) object Required: Yes

(43)

Response Syntax

The ID of the AWS account that owns the transit virtual interface.

Response Syntax

{ "virtualInterface": { "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number,

"authKey": "string", "awsDeviceV2": "string",

"awsLogicalDeviceId": "string", "bgpPeers": [

{

} ],

"mtu": number,

"cidr": "string"

} ],

{

} ],

}}

(44)

Response Elements

virtualInterface (p. 31)

Information about a virtual interface.

Type: VirtualInterface (p. 262) object

Errors

AssociateConnectionWithLag

Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS is interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a diﬀerent LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.

Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a diﬀerent LAG, the virtual interfaces remain associated with the original LAG.

For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a diﬀerent LAG, the hosted connections remain associated with the original LAG.

Request Syntax

{ "connectionId": "string", "lagId": "string"

}

Request Parameters

Type: String Required: Yes lagId (p. 33)

The ID of the LAG with which to associate the connection.

Response Syntax

{

"awsDevice": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bandwidth": "string",

"connectionId": "string",

(46)

Response Elements

"connectionName": "string", "connectionState": "string", "encryptionMode": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string",

{

} ],

{

} ],

"vlan": number }

Response Elements

Type: String

(47)

Response Elements

Type: String

connectionName (p. 33)

Type: String

IPv6).

Type: String

The ID of the LAG.

Type: String

AWS Direct Connect

AWS Direct Connect

API Reference

API Version 2012-10-25

AWS Direct Connect: API Reference

Table of Contents

Welcome

Actions

AcceptDirectConnectGatewayAssociationProposal

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

AllocateConnectionOnInterconnect

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

AllocateHostedConnection

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

AllocatePrivateVirtualInterface

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

AllocatePublicVirtualInterface

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

AllocateTransitVirtualInterface

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

AssociateConnectionWithLag

Request Syntax

Request Parameters

Response Syntax

Response Elements