Post x amz targetovertureservice.allocateconnectiononinterconnect

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463248219.5 KB

Deprecated. Use AllocateHostedConnection instead.

Creates a hosted connection on an interconnect.

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

Intended for use by Direct Connect Partners only.

post/#X-Amz-Target=OvertureService.AllocateConnectionOnInterconnect

Headers

X-Amz-Target'OvertureService.AllocateConnectionOnInterconnect' required

Request body

bandwidthstring required

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

connectionNamestring required

The name of the provisioned connection.

ownerAccountstring required

The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned.

interconnectIdstring required

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

vlaninteger required

The dedicated VLAN provisioned to the connection.

Response

Success

ownerAccountstring

The ID of the Amazon Web Services account that owns the connection.

connectionIdstring

The ID of the connection.

connectionNamestring

The name of the connection.

The state of the connection. The following are the possible values: <ul> <li> <code>ordering</code>: 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. </li> <li> <code>requested</code>: 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. </li> <li> <code>pending</code>: The connection has been approved and is being initialized. </li> <li> <code>available</code>: The network link is up and the connection is ready for use. </li> <li> <code>down</code>: The network link is down. </li> <li> <code>deleting</code>: The connection is being deleted. </li> <li> <code>deleted</code>: The connection has been deleted. </li> <li> <code>rejected</code>: A hosted connection in the <code>ordering</code> state enters the <code>rejected</code> state if it is deleted by the customer. </li> <li> <code>unknown</code>: The state of the connection is not available. </li> </ul>

regionstring

The Amazon Web Services Region where the connection is located.

locationstring

The location of the connection.

bandwidthstring

The bandwidth of the connection.

vlaninteger

The ID of the VLAN.

partnerNamestring

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

loaIssueTimestring date-time

The time of the most recent call to <a>DescribeLoa</a> for this connection.

lagIdstring

The ID of the LAG.

awsDevicestring

The Direct Connect endpoint on which the physical connection terminates.

jumboFrameCapableboolean

Indicates whether jumbo frames (9001 MTU) are supported.

awsDeviceV2string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceIdstring

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

hasLogicalRedundancy'unknown' | 'yes' | 'no'

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

providerNamestring

The name of the service provider associated with the connection.

macSecCapableboolean

Indicates whether the connection supports MAC Security (MACsec).

portEncryptionStatusstring

The MAC Security (MACsec) port link status of the connection. The valid values are <code>Encryption Up</code>, which means that there is an active Connection Key Name, or <code>Encryption Down</code>.

encryptionModestring

The MAC Security (MACsec) connection encryption mode. The valid values are <code>no_encrypt</code>, <code>should_encrypt</code>, and <code>must_encrypt</code>.