Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463248219.5 KB

Updates the Direct Connect dedicated connection configuration.

You can update the following parameters for a connection:

  • The connection name

  • The connection's MAC Security (MACsec) encryption mode.

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

Headers

X-Amz-Target'OvertureService.UpdateConnection' required

Request body

connectionIdstring required
<p>The ID of the dedicated connection.</p> <p>You can use <a>DescribeConnections</a> to retrieve the connection ID.</p>
connectionNamestring

The name of the connection.

encryptionModestring
<p>The connection 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>

Response

Success

ownerAccountstring

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

connectionIdstring

The ID of the connection.

connectionNamestring

The name of the connection.

connectionState'ordering' | 'requested' | 'pending' | 'available' | 'down' | 'deleting' | 'deleted' | 'rejected' | 'unknown'
<p>The state of the connection. The following are the possible values:</p> <ul> <li> <p> <code>ordering</code>: 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.</p> </li> <li> <p> <code>requested</code>: 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.</p> </li> <li> <p> <code>pending</code>: The connection has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up and the connection is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The connection is being deleted.</p> </li> <li> <p> <code>deleted</code>: The connection has been deleted.</p> </li> <li> <p> <code>rejected</code>: A hosted connection in the <code>ordering</code> state enters the <code>rejected</code> state if it is deleted by the customer.</p> </li> <li> <p> <code>unknown</code>: The state of the connection is not available.</p> </li> </ul>
regionstring

The Amazon Web Services Region where the connection is located.

locationstring

The location of the connection.

bandwidthstring

The bandwidth of the connection.

vlaninteger

The ID of the VLAN.

partnerNamestring

The name of the Direct Connect service provider associated with the connection.

loaIssueTimestring date-time

The time of the most recent call to <a>DescribeLoa</a> for this connection.

lagIdstring

The ID of the LAG.

awsDevicestring

The Direct Connect endpoint on which the physical connection terminates.

jumboFrameCapableboolean

Indicates whether jumbo frames (9001 MTU) are supported.

awsDeviceV2string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceIdstring

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

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

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

providerNamestring

The name of the service provider associated with the connection.

macSecCapableboolean

Indicates whether the connection supports MAC Security (MACsec).

portEncryptionStatusstring
<p>The MAC Security (MACsec) port link status of the connection.</p> <p>The valid values are <code>Encryption Up</code>, which means that there is an active Connection Key Name, or <code>Encryption Down</code>.</p>
encryptionModestring
<p>The MAC Security (MACsec) connection encryption mode.</p> <p>The valid values are <code>no_encrypt</code>, <code>should_encrypt</code>, and <code>must_encrypt</code>.</p>