Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateConnection

Updates the AWS Direct Connect connection configuration.

You can update the following parameters for a connection:

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

Request Syntax


{
   "connectionId": "string",
   "connectionName": "string",
   "encryptionMode": "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.

connectionId

The ID of the connection.

You can use DescribeConnections to retrieve the connection ID.

Type: String

Required: Yes

connectionName

The name of the connection.

Type: String

Required: No

encryptionMode

The connection MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

Type: String

Required: No

Response Syntax


{
   "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
}

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.

awsDevice

This parameter has been deprecated.

The Direct Connect endpoint on which the physical connection terminates.

Type: String

awsDeviceV2

The Direct Connect endpoint that terminates the physical connection.

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

bandwidth

The bandwidth of the connection.

Type: String

connectionId

The ID of the connection.

Type: String

connectionName

The name of the connection.

Type: String

connectionState

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

ordering: 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.
requested: 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.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.