DirectConnect / Client / disassociate_mac_sec_key

disassociate_mac_sec_key

DirectConnect.Client.disassociate_mac_sec_key(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.disassociate_mac_sec_key(
    connectionId='string',
    secretARN='string'
)
Parameters:

  • connectionId (string) –

    [REQUIRED]

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

    You can use DescribeConnections, DescribeInterconnects, or DescribeLags to retrieve connection ID.

  • secretARN (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'connectionId': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • connectionId (string) –

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

    • macSecKeys (list) –

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

      • (dict) –

        Information about the MAC Security (MACsec) secret key.

        • secretARN (string) –

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

        • ckn (string) –

          The Connection Key Name (CKN) for the MAC Security secret key.

        • state (string) –

          The state of the MAC Security (MACsec) secret key.

          The possible values are:

          • associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.

          • associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.

          • disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG

          • disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.

        • startOn (string) –

          The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.

Exceptions