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

AllocateHostedConnection

Creates a hosted connection on the specified 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.

Note

Intended for use by AWS Direct Connect Partners only.

Request Syntax

{ "bandwidth": "string", "connectionId": "string", "connectionName": "string", "ownerAccount": "string", "tags": [ { "key": "string", "value": "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

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 specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

Type: String

Required: Yes

connectionId

The ID of the interconnect or LAG.

Type: String

Required: Yes

connectionName

The name of the hosted connection.

Type: String

Required: Yes

ownerAccount

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

Type: String

Required: Yes

tags

The tags to assign to the hosted connection.

Type: Array of Tag objects

Array Members: Minimum number of 1 item.

Required: No

vlan

The dedicated VLAN provisioned to the hosted connection.

Type: Integer

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.

awsDevice

This parameter has been deprecated.

The Direct Connect endpoint on which the physical connection terminates.

Type: String

awsDeviceV2

The Direct Connect endpoint on which the physical connection terminates.

Type: String

bandwidth

The bandwidth of the connection.

Type: String

connectionId

The ID of the connection.

Type: String

connectionName

The name of the connection.

Type: String

connectionState

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

hasLogicalRedundancy

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

Type: String

Valid Values: unknown | yes | no

jumboFrameCapable

Indicates whether jumbo frames (9001 MTU) are supported.

Type: Boolean

lagId

The ID of the LAG.

Type: String

loaIssueTime

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

Type: Timestamp

location

The location of the connection.

Type: String

ownerAccount

The ID of the AWS account that owns the 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.

Type: String

tags

Any tags assigned to the connection.

Type: Array of Tag objects

Array Members: Minimum number of 1 item.

vlan

The ID of the VLAN.

Type: Integer

Errors

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

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: