Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463248219.5 KB

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

You can update the following LAG 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.

  • The LAG's MACsec encryption mode.

    Amazon Web Services assigns this value to each connection which is part of the LAG.

  • The tags

If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.

post/#X-Amz-Target=OvertureService.UpdateLag

Headers

X-Amz-Target'OvertureService.UpdateLag' required

Request body

lagIdstring required

The ID of the LAG.

lagNamestring

The name of the LAG.

minimumLinksinteger

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

encryptionModestring
<p>The LAG MAC Security (MACsec) encryption mode.</p> <p>Amazon Web Services applies the value to all connections which are part of the LAG.</p>

Response

Success

connectionsBandwidthstring

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.

numberOfConnectionsinteger

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

lagIdstring

The ID of the LAG.

ownerAccountstring

The ID of the Amazon Web Services account that owns the LAG.

lagNamestring

The name of the LAG.

lagState'requested' | 'pending' | 'available' | 'down' | 'deleting' | 'deleted' | 'unknown'
<p>The state of the LAG. The following are the possible values:</p> <ul> <li> <p> <code>requested</code>: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.</p> </li> <li> <p> <code>pending</code>: The LAG has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is established and the LAG is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The LAG is being deleted.</p> </li> <li> <p> <code>deleted</code>: The LAG is deleted.</p> </li> <li> <p> <code>unknown</code>: The state of the LAG is not available.</p> </li> </ul>
locationstring

The location of the LAG.

regionstring

The Amazon Web Services Region where the connection is located.

minimumLinksinteger

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

awsDevicestring

The Direct Connect endpoint that hosts the LAG.

awsDeviceV2string

The Direct Connect endpoint that hosts the LAG.

awsLogicalDeviceIdstring

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

allowsHostedConnectionsboolean

Indicates whether the LAG can host other connections.

jumboFrameCapableboolean

Indicates whether jumbo frames (9001 MTU) are supported.

hasLogicalRedundancy'unknown' | 'yes' | 'no'

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

providerNamestring

The name of the service provider associated with the LAG.

macSecCapableboolean

Indicates whether the LAG supports MAC Security (MACsec).

encryptionModestring
<p>The LAG MAC Security (MACsec) encryption mode.</p> <p>The valid values are <code>no_encrypt</code>, <code>should_encrypt</code>, and <code>must_encrypt</code>.</p>