Skip to content

update_connection

update_connection(
    global_network_id: GlobalNetworkId,
    connection_id: ConnectionId,
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
    link_id: Optional[LinkId] = None,
    connected_link_id: Optional[LinkId] = None,
    description: Optional[ConstrainedString] = None,
) -> UpdateConnectionResponse

Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.

Parameters:

  • global_network_id (GlobalNetworkId) –

    The ID of the global network.

  • connection_id (ConnectionId) –

    The ID of the connection.

  • link_id (Optional[LinkId], default: None ) –

    The ID of the link for the first device in the connection.

  • connected_link_id (Optional[LinkId], default: None ) –

    The ID of the link for the second device in the connection.

  • description (Optional[ConstrainedString], default: None ) –

    A description of the connection.

    Length Constraints: Maximum length of 256 characters.

Raises:

Source code in docs_src/capo_networkmanager/_services/network_manager.py
def update_connection(
    self,
    global_network_id: "capo_networkmanager.types.global_network_id.GlobalNetworkId",
    connection_id: "capo_networkmanager.types.connection_id.ConnectionId",
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
    link_id: Optional["capo_networkmanager.types.link_id.LinkId"] = None,
    connected_link_id: Optional["capo_networkmanager.types.link_id.LinkId"] = None,
    description: Optional[
        "capo_networkmanager.types.constrained_string.ConstrainedString"
    ] = None,
) -> (
    "capo_networkmanager.types.update_connection_response.UpdateConnectionResponse"
):
    """<p>Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.</p>

    Args:
        global_network_id: <p>The ID of the global network.</p>
        connection_id: <p>The ID of the connection.</p>
        link_id: <p>The ID of the link for the first device in the connection.</p>
        connected_link_id: <p>The ID of the link for the second device in the connection.</p>
        description: <p>A description of the connection.</p> <p>Length Constraints: Maximum length of 256 characters.</p>

    Raises:
        capo_networkmanager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_networkmanager.errors.conflict_exception.ConflictException: <p>There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.</p>
        capo_networkmanager.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal error.</p>
        capo_networkmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
        capo_networkmanager.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_networkmanager.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints.</p>
        capo_networkmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_networkmanager.types.update_connection_request.UpdateConnectionRequest]",
    ) -> OperationResponse[
        "capo_networkmanager.types.update_connection_response.UpdateConnectionResponse"
    ]:
        import capo_networkmanager._operations.network_manager.update_connection

        output, http_response = (
            capo_networkmanager._operations.network_manager.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_networkmanager.types.update_connection_request.UpdateConnectionRequest = {
        "global_network_id": global_network_id,
        "connection_id": connection_id,
    }
    if link_id is not None:
        input_["link_id"] = link_id
    if connected_link_id is not None:
        input_["connected_link_id"] = connected_link_id
    if description is not None:
        input_["description"] = description

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