"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.
awsDevice (p. 13)
This parameter has been deprecated.
The Direct Connect endpoint on which the physical connection terminates.
Type: String awsDeviceV2 (p. 13)
The Direct Connect endpoint that terminates the physical connection.
Type: String
awsLogicalDeviceId (p. 13)
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Type: String bandwidth (p. 13)
The bandwidth of the connection.
Type: String connectionId (p. 13)
The ID of the connection.
Type: String
connectionName (p. 13)
The name of the connection.
Type: String connectionState (p. 13)
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.
Response Elements
• 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
encryptionMode (p. 13)
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
Type: String
hasLogicalRedundancy (p. 13)
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. 13)
Indicates whether jumbo frames (9001 MTU) are supported.
Type: Boolean lagId (p. 13)
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)
The location of the connection.
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
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.
Type: String region (p. 13)
The AWS Region where the connection is located.
Type: String tags (p. 13)
The tags associated with the connection.
Type: Array of Tag (p. 260) objects
Array Members: Minimum number of 1 item.
vlan (p. 13)
The ID of the VLAN.
Type: Integer
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 DuplicateTagKeysException
A tag key was specified more than once.
HTTP Status Code: 400 TooManyTagsException
You have reached the limit on the number of tags that can be assigned.
See Also
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AllocatePrivateVirtualInterface
AllocatePrivateVirtualInterface
Provisions a private virtual interface to be owned by the specified AWS account.
Virtual interfaces created using this action must be confirmed by the owner using
ConfirmPrivateVirtualInterface (p. 56). Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
Request Syntax
{ "connectionId": "string",
"newPrivateVirtualInterfaceAllocation": { "addressFamily": "string",
"amazonAddress": "string", "asn": number,
"authKey": "string",
"customerAddress": "string", "mtu": number,
"virtualInterfaceName": "string", "vlan": number
},
"ownerAccount": "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.
connectionId (p. 18)
The ID of the connection on which the private virtual interface is provisioned.
Type: String Required: Yes
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.
Type: String Required: Yes
Response Syntax
Response Syntax
{
"addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number,
"authKey": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bgpPeers": [
"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
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
addressFamily (p. 19)
The address family for the BGP peer.
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) configuration.
The valid values are 1-2147483647.
Type: Integer authKey (p. 19)
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
Type: String awsDeviceV2 (p. 19)
The Direct Connect endpoint that terminates the physical connection.
Type: String
awsLogicalDeviceId (p. 19)
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Type: String bgpPeers (p. 19)
The BGP peers configured on this virtual interface.
Type: Array of BGPPeer (p. 216) objects connectionId (p. 19)
The ID of the connection.
Type: String
customerAddress (p. 19)
The IP address assigned to the customer interface.
Type: String
customerRouterConfig (p. 19)
The customer router configuration.
Type: String
Response Elements
directConnectGatewayId (p. 19)
The ID of the Direct Connect gateway.
Type: String
jumboFrameCapable (p. 19)
Indicates whether jumbo frames (9001 MTU) are supported.
Type: Boolean location (p. 19)
The location of the connection.
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.
Type: String region (p. 19)
The AWS Region where the virtual interface is located.
Type: String
routeFilterPrefixes (p. 19)
The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
Type: Array of RouteFilterPrefix (p. 257) objects siteLinkEnabled (p. 19)
Indicates whether SiteLink is enabled.
Type: Boolean tags (p. 19)
The tags associated with the virtual interface.
Type: Array of Tag (p. 260) objects
Array Members: Minimum number of 1 item.
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
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 traffic.
• available: A virtual interface that is able to forward traffic.
• 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 traffic.
• deleted: A virtual interface that cannot forward traffic.
• 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
Valid Values: confirming | verifying | pending | available | down | deleting | deleted | rejected | unknown
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
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.
See Also
HTTP Status Code: 400 DuplicateTagKeysException
A tag key was specified more than once.
HTTP Status Code: 400 TooManyTagsException
You have reached the limit on the number of tags that can be assigned.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AllocatePublicVirtualInterface
AllocatePublicVirtualInterface
Provisions a public virtual interface to be owned by the specified AWS account.
The owner of a connection calls this function to provision a public virtual interface to be owned by the specified AWS account.
Virtual interfaces created using this function must be confirmed by the owner using
ConfirmPublicVirtualInterface (p. 59). Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
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",
"amazonAddress": "string", "asn": number,
"authKey": "string",
"customerAddress": "string", "routeFilterPrefixes": [
"virtualInterfaceName": "string", "vlan": number
},
"ownerAccount": "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.
connectionId (p. 24)
The ID of the connection on which the public virtual interface is provisioned.
Type: String Required: Yes
newPublicVirtualInterfaceAllocation (p. 24) Information about the public virtual interface.
Response Syntax
Type: NewPublicVirtualInterfaceAllocation (p. 250) object Required: Yes
ownerAccount (p. 24)
The ID of the AWS account that owns the public virtual interface.
Type: String Required: Yes
Response Syntax
{ "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number,
"authKey": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bgpPeers": [
"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
}
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.
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) configuration.
The valid values are 1-2147483647.
Type: Integer authKey (p. 25)
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
Type: String awsDeviceV2 (p. 25)
The Direct Connect endpoint that terminates the physical connection.
Type: String
awsLogicalDeviceId (p. 25)
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Type: String bgpPeers (p. 25)
The BGP peers configured on this virtual interface.
Type: Array of BGPPeer (p. 216) objects connectionId (p. 25)
The ID of the connection.
Response Elements
Type: String
customerAddress (p. 25)
The IP address assigned to the customer interface.
Type: String
customerRouterConfig (p. 25)
The customer router configuration.
Type: String
directConnectGatewayId (p. 25)
The ID of the Direct Connect gateway.
Type: String
jumboFrameCapable (p. 25)
Indicates whether jumbo frames (9001 MTU) are supported.
Type: Boolean location (p. 25)
The location of the connection.
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.
Type: String region (p. 25)
The AWS Region where the virtual interface is located.
Type: String
routeFilterPrefixes (p. 25)
The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
Type: Array of RouteFilterPrefix (p. 257) objects siteLinkEnabled (p. 25)
Indicates whether SiteLink is enabled.
Type: Boolean tags (p. 25)
The tags associated with the virtual interface.
Type: Array of Tag (p. 260) objects
Array Members: Minimum number of 1 item.
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 traffic.
• available: A virtual interface that is able to forward traffic.
• 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 traffic.
• deleted: A virtual interface that cannot forward traffic.
• 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
Valid Values: confirming | verifying | pending | available | down | deleting | deleted | rejected | unknown
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
For information about the errors that are common to all actions, see Common Errors (p. 270).
See Also
DirectConnectClientException
One or more parameters are not valid.
HTTP Status Code: 400 DirectConnectServerException
A server-side error occurred.
HTTP Status Code: 400 DuplicateTagKeysException
A tag key was specified more than once.
HTTP Status Code: 400 TooManyTagsException
You have reached the limit on the number of tags that can be assigned.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AllocateTransitVirtualInterface
AllocateTransitVirtualInterface
Provisions a transit virtual interface to be owned by the specified 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 specified AWS account.
After you create a transit virtual interface, it must be confirmed by the owner using
ConfirmTransitVirtualInterface (p. 61). Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
Request Syntax
{ "connectionId": "string",
"newTransitVirtualInterfaceAllocation": { "addressFamily": "string",
"amazonAddress": "string", "asn": number,
"authKey": "string",
"customerAddress": "string", "mtu": number,
"tags": [ {
"key": "string", "value": "string"
} ],
"virtualInterfaceName": "string", "vlan": number
},
"ownerAccount": "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.
connectionId (p. 30)
The ID of the connection on which the transit virtual interface is provisioned.
Type: String Required: Yes
newTransitVirtualInterfaceAllocation (p. 30)
Information about the transit virtual interface.
Type: NewTransitVirtualInterfaceAllocation (p. 254) object Required: Yes
Response Syntax
ownerAccount (p. 30)
The ID of the AWS account that owns the transit virtual interface.
Type: String Required: Yes
Response Syntax
{ "virtualInterface": { "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number,
"authKey": "string", "awsDeviceV2": "string",
"awsLogicalDeviceId": "string", "bgpPeers": [
"connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string",
"mtu": number,
"ownerAccount": "string", "region": "string",
"siteLinkEnabled": boolean, "tags": [
"virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number
}}
Response Elements
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.
virtualInterface (p. 31)
Information about a virtual interface.
Type: VirtualInterface (p. 262) 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 DuplicateTagKeysException
A tag key was specified more than once.
HTTP Status Code: 400 TooManyTagsException
You have reached the limit on the number of tags that can be assigned.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AssociateConnectionWithLag
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 different 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 different 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 different LAG, the hosted connections remain associated with the original LAG.
Request Syntax
{ "connectionId": "string", "lagId": "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.
The request accepts the following data in JSON format.