Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DeleteLag

Deletes the specified 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.

Type: String

Required: Yes

Response Syntax


{
   "allowsHostedConnections": boolean,
   "awsDevice": "string",
   "awsDeviceV2": "string",
   "awsLogicalDeviceId": "string",
   "connections": [ 
      { 
         "awsDevice": "string",
         "awsDeviceV2": "string",
         "awsLogicalDeviceId": "string",
         "bandwidth": "string",
         "connectionId": "string",
         "connectionName": "string",
         "connectionState": "string",
         "encryptionMode": "string",
         "hasLogicalRedundancy": "string",
         "jumboFrameCapable": boolean,
         "lagId": "string",
         "loaIssueTime": number,
         "location": "string",
         "macSecCapable": boolean,
         "macSecKeys": [ 
            { 
               "ckn": "string",
               "secretARN": "string",
               "startOn": "string",
               "state": "string"
            }
         ],
         "ownerAccount": "string",
         "partnerInterconnectMacSecCapable": boolean,
         "partnerName": "string",
         "portEncryptionStatus": "string",
         "providerName": "string",
         "region": "string",
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "vlan": number
      }
   ],
   "connectionsBandwidth": "string",
   "encryptionMode": "string",
   "hasLogicalRedundancy": "string",
   "jumboFrameCapable": boolean,
   "lagId": "string",
   "lagName": "string",
   "lagState": "string",
   "location": "string",
   "macSecCapable": boolean,
   "macSecKeys": [ 
      { 
         "ckn": "string",
         "secretARN": "string",
         "startOn": "string",
         "state": "string"
      }
   ],
   "minimumLinks": number,
   "numberOfConnections": number,
   "ownerAccount": "string",
   "providerName": "string",
   "region": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "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.

Type: Boolean

awsDevice

This parameter has been deprecated.

The Amazon Direct Connect endpoint that hosts the LAG.

Type: String

awsDeviceV2

The Amazon Direct Connect endpoint that hosts the LAG.

Type: String

awsLogicalDeviceId

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

Type: String

connections

The connections bundled by the LAG.

Type: Array of Connection objects

connectionsBandwidth

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

Type: String

encryptionMode

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

Type: String

hasLogicalRedundancy

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

Type: String

Valid Values: unknown | yes | no

jumboFrameCapable

Indicates whether jumbo frames are supported.

Type: Boolean

lagId

The ID of the LAG.

Type: String

lagName

The name of the LAG.

Type: String

lagState

The state of the LAG. The following are the possible values:

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 being deleted.
deleted: The LAG is deleted.
unknown: The state of the LAG is not available.

Type: String

location

The location of the LAG.

Type: String

macSecCapable

Indicates whether the LAG supports MAC Security (MACsec).

Type: Boolean

macSecKeys

The MAC Security (MACsec) security keys associated with the LAG.

Type: Array of MacSecKey objects

minimumLinks

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

Type: Integer

numberOfConnections

The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

Type: Integer

ownerAccount