DisassociateMacSecKey - AWS Direct Connect

DisassociateMacSecKey

Removes the association between a MAC Security (MACsec) security key and an AWS Direct Connect dedicated connection.

Request Syntax

{ "connectionId": "string", "secretARN": "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 dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

Type: String

Required: Yes

secretARN

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

You can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key.

Type: String

Required: Yes

Response Syntax

{ "connectionId": "string", "macSecKeys": [ { "ckn": "string", "secretARN": "string", "startOn": "string", "state": "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.

connectionId

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

Type: String

macSecKeys

The MAC Security (MACsec) security keys no longer associated with the dedicated connection.

Type: Array of MacSecKey objects

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: