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

AllocateConnectionOnInterconnect

Deprecated in favor of AllocateHostedConnection.

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 given interconnect.

Note

This is intended for use by AWS Direct Connect partners only.

Request Syntax

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

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.

bandwidth

Bandwidth of the connection.

Example: "500Mbps"

Default: None

Values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps

Type: String

Required: Yes

connectionName

Name of the provisioned connection.

Example: "500M Connection to AWS"

Default: None

Type: String

Required: Yes

interconnectId

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

Example: dxcon-456abc78

Default: None

Type: String

Required: Yes

ownerAccount

Numeric account Id of the customer for whom the connection will be provisioned.

Example: 123443215678

Default: None

Type: String

Required: Yes

vlan

The dedicated VLAN provisioned to the connection.

Example: 101

Default: None

Type: Integer

Required: Yes

Response Syntax

{
   "awsDevice": "string",
   "bandwidth": "string",
   "connectionId": "string",
   "connectionName": "string",
   "connectionState": "string",
   "lagId": "string",
   "loaIssueTime": number,
   "location": "string",
   "ownerAccount": "string",
   "partnerName": "string",
   "region": "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.

awsDevice

The Direct Connection endpoint which the physical connection terminates on.

Type: String

bandwidth

Bandwidth of the connection.

Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

Default: None

Type: String

connectionId

The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

Example: dxcon-fg5678gh

Default: None

Type: String

connectionName

The name of the connection.

Example: "My Connection to AWS"

Default: None

Type: String

connectionState

State of the connection.

  • 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 in the process of being deleted.

  • Deleted: The connection has been deleted.

  • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

Type: String

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

lagId

The ID of the LAG.

Example: dxlag-fg5678gh

Type: String

loaIssueTime

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

Type: Timestamp

location

Where the connection is located.

Example: EqSV5

Default: None

Type: String

ownerAccount

The AWS account that will own the new connection.

Type: String

partnerName

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

Type: String

region

The AWS region where the connection is located.

Example: us-east-1

Default: None

Type: String

vlan

The VLAN ID.

Example: 101

Type: Integer

Errors

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

DirectConnectClientException

The API was called with invalid parameters. The error message will contain additional details about the cause.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred during the API call. The error message will contain additional details about the cause.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: