update_connection ¶

update_connection(
    connection_id: ConnectionId,
    *,
    config_overrides: Optional[DirectConnectClientConfig] = None,
    connection_name: Optional[ConnectionName] = None,
    encryption_mode: Optional[EncryptionMode] = None,
) -> Connection

Updates the Direct Connect connection configuration.

You can update the following parameters for a connection:

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

Parameters:

connection_id (ConnectionId) –

The ID of the connection.

You can use DescribeConnections to retrieve the connection ID.
connection_name (Optional[ConnectionName], default: None ) –

The name of the connection.
encryption_mode (Optional[EncryptionMode], default: None ) –

The connection MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

Raises:

DirectConnectClientException –

One or more parameters are not valid.
DirectConnectServerException –

A server-side error occurred.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_direct_connect/_services/direct_connect.py

def update_connection(
    self,
    connection_id: "capo_direct_connect.types.connection_id.ConnectionId",
    *,
    config_overrides: Optional[DirectConnectClientConfig] = None,
    connection_name: Optional[
        "capo_direct_connect.types.connection_name.ConnectionName"
    ] = None,
    encryption_mode: Optional[
        "capo_direct_connect.types.encryption_mode.EncryptionMode"
    ] = None,
) -> "capo_direct_connect.types.connection.Connection":
    """<p>Updates the Direct Connect connection configuration.</p> <p>You can update the following parameters for a connection:</p> <ul> <li> <p>The connection name</p> </li> <li> <p>The connection's MAC Security (MACsec) encryption mode.</p> </li> </ul>

    Args:
        connection_id: <p>The ID of the connection.</p> <p>You can use <a>DescribeConnections</a> to retrieve the connection ID.</p>
        connection_name: <p>The name of the connection.</p>
        encryption_mode: <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>

    Raises:
        capo_direct_connect.errors.direct_connect_client_exception.DirectConnectClientException: <p>One or more parameters are not valid.</p>
        capo_direct_connect.errors.direct_connect_server_exception.DirectConnectServerException: <p>A server-side error occurred.</p>
        capo_direct_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_direct_connect.types.update_connection_request.UpdateConnectionRequest]",
    ) -> OperationResponse["capo_direct_connect.types.connection.Connection"]:
        import capo_direct_connect._operations.overture_service.update_connection

        output, http_response = (
            capo_direct_connect._operations.overture_service.update_connection.update_connection(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateConnection")
    )
    input_: capo_direct_connect.types.update_connection_request.UpdateConnectionRequest = {
        "connection_id": connection_id
    }
    if connection_name is not None:
        input_["connection_name"] = connection_name
    if encryption_mode is not None:
        input_["encryption_mode"] = encryption_mode

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output