Skip to content

delete_user

delete_user(
    user_name: UserName, *, config_overrides: Optional[MemoryDBClientConfig] = None
) -> DeleteUserResponse

Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.

Parameters:

  • user_name (UserName) –

    The name of the user to delete

Raises:

Source code in docs_src/capo_memorydb/_services/memory_db.py
def delete_user(
    self,
    user_name: "capo_memorydb.types.user_name.UserName",
    *,
    config_overrides: Optional[MemoryDBClientConfig] = None,
) -> "capo_memorydb.types.delete_user_response.DeleteUserResponse":
    """<p>Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.</p>

    Args:
        user_name: <p>The name of the user to delete</p>

    Raises:
        capo_memorydb.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The specified parameter value is not valid.</p>
        capo_memorydb.errors.invalid_user_state_fault.InvalidUserStateFault: <p>The user is not in a valid state for the requested operation.</p>
        capo_memorydb.errors.user_not_found_fault.UserNotFoundFault: <p>The specified user does not exist.</p>
        capo_memorydb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_memorydb.types.delete_user_request.DeleteUserRequest]",
    ) -> OperationResponse[
        "capo_memorydb.types.delete_user_response.DeleteUserResponse"
    ]:
        import capo_memorydb._operations.amazon_memory_db.delete_user

        output, http_response = (
            capo_memorydb._operations.amazon_memory_db.delete_user.delete_user(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteUser")
    )
    input_: capo_memorydb.types.delete_user_request.DeleteUserRequest = {
        "user_name": user_name
    }

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