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

DeleteLag

Deletes a link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.

Request Syntax

{
   "lagId": "string"
}

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.

lagId

The ID of the LAG to delete.

Example: dxlag-abc123

Default: None

Type: String

Required: Yes

Response Syntax

{
   "allowsHostedConnections": boolean,
   "awsDevice": "string",
   "connections": [ 
      { 
         "awsDevice": "string",
         "bandwidth": "string",
         "connectionId": "string",
         "connectionName": "string",
         "connectionState": "string",
         "lagId": "string",
         "loaIssueTime": number,
         "location": "string",
         "ownerAccount": "string",
         "partnerName": "string",
         "region": "string",
         "vlan": number
      }
   ],
   "connectionsBandwidth": "string",
   "lagId": "string",
   "lagName": "string",
   "lagState": "string",
   "location": "string",
   "minimumLinks": number,
   "numberOfConnections": number,
   "ownerAccount": "string",
   "region": "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.

allowsHostedConnections

Indicates whether the LAG can host other connections.

Note

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

Type: Boolean

awsDevice

The AWS Direct Connection endpoint that hosts the LAG.

Type: String

connections

A list of connections bundled by this LAG.

Type: Array of Connection objects

connectionsBandwidth

The individual bandwidth of the physical connections bundled by the LAG.

Available values: 1Gbps, 10Gbps

Type: String

lagId

The ID of the LAG.

Example: dxlag-fg5678gh

Type: String

lagName

The name of the LAG.

Type: String

lagState

The state of the LAG.

  • Requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

  • Pending: The LAG has been approved, and is being initialized.

  • Available: The network link is established, and the LAG is ready for use.

  • Down: The network link is down.

  • Deleting: The LAG is in the process of being deleted.

  • Deleted: The LAG has been deleted.

Type: String

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

location

Where the connection is located.

Example: EqSV5

Default: None

Type: String

minimumLinks

The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down. This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.

Type: Integer

numberOfConnections

The number of physical connections bundled by the LAG, up to a maximum of 10.

Type: Integer

ownerAccount

The owner of the LAG.

Type: String

region

The AWS region where the connection is located.

Example: us-east-1

Default: None

Type: String

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: