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

UpdateLag

Updates the attributes of the specified link aggregation group (LAG).

You can update the following attributes:

  • The name of the LAG.

  • The value for the minimum number of connections that must be operational for the LAG itself to be operational.

When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value and the number of operational connections falls below the specified value, the LAG automatically goes down to avoid over-utilization of the remaining connections. Adjust this value with care, as it could force the LAG down if it is set higher than the current number of operational connections.

Request Syntax

{ "lagId": "string", "lagName": "string", "minimumLinks": 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.

lagId

The ID of the LAG.

Type: String

Required: Yes

lagName

The name of the LAG.

Type: String

Required: No

minimumLinks

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

Type: Integer

Required: No

Response Syntax

{ "allowsHostedConnections": boolean, "awsDevice": "string", "awsDeviceV2": "string", "connections": [ { "awsDevice": "string", "awsDeviceV2": "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.

Type: Boolean

awsDevice

[Deprecated. Use awsDeviceV2 instead] The Direct Connect endpoint that hosts the LAG.

Type: String

awsDeviceV2

The Direct Connect endpoint that hosts the LAG.

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 and 10Gbps.

Type: String

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.

Type: String

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

location

The location of the LAG.

Type: String

minimumLinks

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

Type: Integer

numberOfConnections

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

Type: Integer

ownerAccount

The ID of the AWS account that owns the LAG.

Type: String

region

The AWS Region where the connection is located.

Type: String

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

See Also

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